diff --git a/androidpublisher/v3/androidpublisher-api.json b/androidpublisher/v3/androidpublisher-api.json index f518609ad34..77a32761b7a 100644 --- a/androidpublisher/v3/androidpublisher-api.json +++ b/androidpublisher/v3/androidpublisher-api.json @@ -5555,7 +5555,7 @@ } } }, - "revision": "20251028", + "revision": "20251119", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Abi": { @@ -6219,6 +6219,12 @@ }, "type": "object" }, + "BaseDetails": { + "description": "Details of a base price pricing phase.", + "id": "BaseDetails", + "properties": {}, + "type": "object" + }, "BasePlan": { "description": "A single base plan for a subscription.", "id": "BasePlan", @@ -7634,6 +7640,21 @@ }, "type": "object" }, + "ExternalAccountIds": { + "description": "User account identifier in your app.", + "id": "ExternalAccountIds", + "properties": { + "obfuscatedAccountId": { + "description": "Optional. Specifies an optional obfuscated string that is uniquely associated with the purchaser's user account in your app. If you pass this value, Google Play can use it to detect irregular activity. Do not use this field to store any Personally Identifiable Information (PII) such as emails in cleartext. Attempting to store PII in this field will result in purchases being blocked. Google Play recommends that you use either encryption or a one-way hash to generate an obfuscated identifier to send to Google Play. This identifier is limited to 64 characters. This field can only be set for resubscription purchases. See https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid to set this field for purchases made using the standard in-app billing flow.", + "type": "string" + }, + "obfuscatedProfileId": { + "description": "Optional. Specifies an optional obfuscated string that is uniquely associated with the purchaser's user profile in your app. If you pass this value, Google Play can use it to detect irregular activity. Do not use this field to store any Personally Identifiable Information (PII) such as emails in cleartext. Attempting to store PII in this field will result in purchases being blocked. Google Play recommends that you use either encryption or a one-way hash to generate an obfuscated identifier to send to Google Play. This identifier is limited to 64 characters. This field can only be set for resubscription purchases. See https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid to set this field for purchases made using the standard in-app billing flow.", + "type": "string" + } + }, + "type": "object" + }, "ExternalSubscription": { "description": "Details of an external subscription.", "id": "ExternalSubscription", @@ -7842,6 +7863,12 @@ }, "type": "object" }, + "FreeTrialDetails": { + "description": "Details of a free trial pricing phase.", + "id": "FreeTrialDetails", + "properties": {}, + "type": "object" + }, "FullRefund": { "description": "A full refund of the remaining amount of a transaction.", "id": "FullRefund", @@ -8576,6 +8603,12 @@ }, "type": "object" }, + "IntroductoryPriceDetails": { + "description": "Details of an introductory price pricing phase.", + "id": "IntroductoryPriceDetails", + "properties": {}, + "type": "object" + }, "IntroductoryPriceInfo": { "description": "Contains the introductory price information for a subscription.", "id": "IntroductoryPriceInfo", @@ -8601,6 +8634,47 @@ }, "type": "object" }, + "ItemReplacement": { + "description": "Details about a subscription line item that is being replaced.", + "id": "ItemReplacement", + "properties": { + "basePlanId": { + "description": "The base plan ID of the subscription line item being replaced.", + "type": "string" + }, + "offerId": { + "description": "The offer ID of the subscription line item being replaced, if applicable.", + "type": "string" + }, + "productId": { + "description": "The product ID of the subscription line item being replaced.", + "type": "string" + }, + "replacementMode": { + "description": "The replacement mode applied during the purchase.", + "enum": [ + "REPLACEMENT_MODE_UNSPECIFIED", + "WITH_TIME_PRORATION", + "CHARGE_PRORATED_PRICE", + "WITHOUT_PRORATION", + "CHARGE_FULL_PRICE", + "DEFERRED", + "KEEP_EXISTING" + ], + "enumDescriptions": [ + "Unspecified replacement mode.", + "The new plan will be prorated and credited from the old plan.", + "The user will be charged a prorated price for the new plan.", + "The new plan will replace the old one without prorating the time.", + "The user will be charged the full price for the new plan.", + "The old plan will be cancelled and the new plan will be effective after the old one expires.", + "The plan will remain unchanged with this replacement." + ], + "type": "string" + } + }, + "type": "object" + }, "LanguageTargeting": { "description": "Targeting based on language.", "id": "LanguageTargeting", @@ -9075,6 +9149,29 @@ }, "type": "object" }, + "OfferPhaseDetails": { + "description": "Details of a pricing phase for the entitlement period funded by this order.", + "id": "OfferPhaseDetails", + "properties": { + "baseDetails": { + "$ref": "BaseDetails", + "description": "The order funds a base price period." + }, + "freeTrialDetails": { + "$ref": "FreeTrialDetails", + "description": "The order funds a free trial period." + }, + "introductoryPriceDetails": { + "$ref": "IntroductoryPriceDetails", + "description": "The order funds an introductory pricing period." + }, + "prorationPeriodDetails": { + "$ref": "ProrationPeriodDetails", + "description": "The order funds a proration period." + } + }, + "type": "object" + }, "OfferTag": { "description": "Represents a custom tag specified for a product offer.", "id": "OfferTag", @@ -9740,6 +9837,21 @@ }, "type": "object" }, + "OutOfAppPurchaseContext": { + "description": "Information specific to an out of app purchase.", + "id": "OutOfAppPurchaseContext", + "properties": { + "expiredExternalAccountIdentifiers": { + "$ref": "ExternalAccountIdentifiers", + "description": "User account identifier from the last expired subscription for this SKU." + }, + "expiredPurchaseToken": { + "description": "The purchase token of the last expired subscription. This purchase token must only be used to help identify the user if the link between the purchaseToken and user is stored in your database. This cannot be used to call the Google Developer API if it has been more than 60 days since expiry.", + "type": "string" + } + }, + "type": "object" + }, "PageInfo": { "description": "Information about the current page. List operations that supports paging return only one \"page\" of results. This protocol buffer message describes the page that has been returned.", "id": "PageInfo", @@ -10197,6 +10309,33 @@ }, "type": "object" }, + "ProrationPeriodDetails": { + "description": "Details of a proration period. A proration period can be a period calculated during a plan change to cover existing entitlements (For more information, see [Allow users to upgrade, downgrade, or change their subscription](https://developer.android.com/google/play/billing/subscriptions#allow-users-change), or a prorated period to align add-on renewal dates with the base (For more information, see [Rules applicable for items in the purchase](https://developer.android.com/google/play/billing/subscription-with-addons#rules-base-addons)).", + "id": "ProrationPeriodDetails", + "properties": { + "linkedOrderId": { + "description": "The last order id of the original subscription purchase prior to the plan change. This is only populated if this proration period is from an ugrade/downgrade from a previous subscription and carries the remaining offer phase from the linked order of the previous subscription.", + "type": "string" + }, + "originalOfferPhase": { + "description": "Represent the original offer phase from the purchased the line item if the proration period contains any of them. For example, a proration period from CHARGE_FULL_PRICE plan change may merge the 1st offer phase of the subscription offer of the new product user purchased. In this case, the original offer phase will be set here.", + "enum": [ + "OFFER_PHASE_UNSPECIFIED", + "BASE", + "INTRODUCTORY", + "FREE_TRIAL" + ], + "enumDescriptions": [ + "Offer phase unspecified. This value is not used.", + "The order funds a base price period.", + "The order funds an introductory pricing period.", + "The order funds a free trial period." + ], + "type": "string" + } + }, + "type": "object" + }, "PurchaseOptionTaxAndComplianceSettings": { "description": "Details about taxation, Google Play policy and legal compliance for one-time product purchase options.", "id": "PurchaseOptionTaxAndComplianceSettings", @@ -11088,7 +11227,7 @@ "type": "string" }, "offerPhase": { - "description": "The pricing phase for the billing period funded by this order.", + "description": "The pricing phase for the billing period funded by this order. Deprecated. Use offer_phase_details instead.", "enum": [ "OFFER_PHASE_UNSPECIFIED", "BASE", @@ -11103,6 +11242,10 @@ ], "type": "string" }, + "offerPhaseDetails": { + "$ref": "OfferPhaseDetails", + "description": "The pricing phase details for the entitlement period funded by this order." + }, "servicePeriodEndTime": { "description": "The end of the billing period funded by this order. This is a snapshot of the billing/service period end time at the moment the order was processed, and should be used only for accounting. To get the current end time of the subscription service period, use purchases.subscriptionsv2.get.", "format": "google-datetime", @@ -11473,6 +11616,10 @@ "format": "google-datetime", "type": "string" }, + "itemReplacement": { + "$ref": "ItemReplacement", + "description": "Details of the item being replaced. This field is only populated if this item replaced another item in a previous subscription and is only available for 60 days after the purchase time." + }, "latestSuccessfulOrderId": { "description": "The order id of the latest successful order associated with this item. Not present if the item is not owned by the user yet (e.g. the item being deferred replaced to).", "type": "string" @@ -11542,6 +11689,10 @@ "description": "The purchase token of the old subscription if this subscription is one of the following: * Re-signup of a canceled but non-lapsed subscription * Upgrade/downgrade from a previous subscription. * Convert from prepaid to auto renewing subscription. * Convert from an auto renewing subscription to prepaid. * Topup a prepaid subscription.", "type": "string" }, + "outOfAppPurchaseContext": { + "$ref": "OutOfAppPurchaseContext", + "description": "Additional context for out of app purchases. This information is only present for re-subscription purchases (subscription purchases made after the previous subscription of the same product has expired) made through the Google Play subscriptions center. This field will be removed after you acknowledge the subscription." + }, "pausedStateContext": { "$ref": "PausedStateContext", "description": "Additional context around paused subscriptions. Only present if the subscription currently has subscription_state SUBSCRIPTION_STATE_PAUSED." @@ -11599,6 +11750,10 @@ "developerPayload": { "description": "Payload to attach to the purchase.", "type": "string" + }, + "externalAccountIds": { + "$ref": "ExternalAccountIds", + "description": "Optional. User account identifier in your app." } }, "type": "object" diff --git a/androidpublisher/v3/androidpublisher-gen.go b/androidpublisher/v3/androidpublisher-gen.go index 67be80fe184..c409f6d2976 100644 --- a/androidpublisher/v3/androidpublisher-gen.go +++ b/androidpublisher/v3/androidpublisher-gen.go @@ -1481,6 +1481,10 @@ func (s AutoRenewingPlan) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// BaseDetails: Details of a base price pricing phase. +type BaseDetails struct { +} + // BasePlan: A single base plan for a subscription. type BasePlan struct { // AutoRenewingBasePlanType: Set when the base plan automatically renews at a @@ -3572,6 +3576,50 @@ func (s ExternalAccountIdentifiers) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// ExternalAccountIds: User account identifier in your app. +type ExternalAccountIds struct { + // ObfuscatedAccountId: Optional. Specifies an optional obfuscated string that + // is uniquely associated with the purchaser's user account in your app. If you + // pass this value, Google Play can use it to detect irregular activity. Do not + // use this field to store any Personally Identifiable Information (PII) such + // as emails in cleartext. Attempting to store PII in this field will result in + // purchases being blocked. Google Play recommends that you use either + // encryption or a one-way hash to generate an obfuscated identifier to send to + // Google Play. This identifier is limited to 64 characters. This field can + // only be set for resubscription purchases. See + // https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid + // to set this field for purchases made using the standard in-app billing flow. + ObfuscatedAccountId string `json:"obfuscatedAccountId,omitempty"` + // ObfuscatedProfileId: Optional. Specifies an optional obfuscated string that + // is uniquely associated with the purchaser's user profile in your app. If you + // pass this value, Google Play can use it to detect irregular activity. Do not + // use this field to store any Personally Identifiable Information (PII) such + // as emails in cleartext. Attempting to store PII in this field will result in + // purchases being blocked. Google Play recommends that you use either + // encryption or a one-way hash to generate an obfuscated identifier to send to + // Google Play. This identifier is limited to 64 characters. This field can + // only be set for resubscription purchases. See + // https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid + // to set this field for purchases made using the standard in-app billing flow. + ObfuscatedProfileId string `json:"obfuscatedProfileId,omitempty"` + // ForceSendFields is a list of field names (e.g. "ObfuscatedAccountId") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ObfuscatedAccountId") to include + // in API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s ExternalAccountIds) MarshalJSON() ([]byte, error) { + type NoMethod ExternalAccountIds + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // ExternalSubscription: Details of an external subscription. type ExternalSubscription struct { // SubscriptionType: Required. The type of the external subscription. @@ -3776,6 +3824,10 @@ func (s ExternallyHostedApk) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// FreeTrialDetails: Details of a free trial pricing phase. +type FreeTrialDetails struct { +} + // FullRefund: A full refund of the remaining amount of a transaction. type FullRefund struct { } @@ -4671,6 +4723,10 @@ func (s InternalAppSharingArtifact) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// IntroductoryPriceDetails: Details of an introductory price pricing phase. +type IntroductoryPriceDetails struct { +} + // IntroductoryPriceInfo: Contains the introductory price information for a // subscription. type IntroductoryPriceInfo struct { @@ -4709,6 +4765,50 @@ func (s IntroductoryPriceInfo) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// ItemReplacement: Details about a subscription line item that is being +// replaced. +type ItemReplacement struct { + // BasePlanId: The base plan ID of the subscription line item being replaced. + BasePlanId string `json:"basePlanId,omitempty"` + // OfferId: The offer ID of the subscription line item being replaced, if + // applicable. + OfferId string `json:"offerId,omitempty"` + // ProductId: The product ID of the subscription line item being replaced. + ProductId string `json:"productId,omitempty"` + // ReplacementMode: The replacement mode applied during the purchase. + // + // Possible values: + // "REPLACEMENT_MODE_UNSPECIFIED" - Unspecified replacement mode. + // "WITH_TIME_PRORATION" - The new plan will be prorated and credited from + // the old plan. + // "CHARGE_PRORATED_PRICE" - The user will be charged a prorated price for + // the new plan. + // "WITHOUT_PRORATION" - The new plan will replace the old one without + // prorating the time. + // "CHARGE_FULL_PRICE" - The user will be charged the full price for the new + // plan. + // "DEFERRED" - The old plan will be cancelled and the new plan will be + // effective after the old one expires. + // "KEEP_EXISTING" - The plan will remain unchanged with this replacement. + ReplacementMode string `json:"replacementMode,omitempty"` + // ForceSendFields is a list of field names (e.g. "BasePlanId") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "BasePlanId") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s ItemReplacement) MarshalJSON() ([]byte, error) { + type NoMethod ItemReplacement + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // LanguageTargeting: Targeting based on language. type LanguageTargeting struct { // Alternatives: Alternative languages. @@ -5328,6 +5428,35 @@ func (s OfferDetails) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// OfferPhaseDetails: Details of a pricing phase for the entitlement period +// funded by this order. +type OfferPhaseDetails struct { + // BaseDetails: The order funds a base price period. + BaseDetails *BaseDetails `json:"baseDetails,omitempty"` + // FreeTrialDetails: The order funds a free trial period. + FreeTrialDetails *FreeTrialDetails `json:"freeTrialDetails,omitempty"` + // IntroductoryPriceDetails: The order funds an introductory pricing period. + IntroductoryPriceDetails *IntroductoryPriceDetails `json:"introductoryPriceDetails,omitempty"` + // ProrationPeriodDetails: The order funds a proration period. + ProrationPeriodDetails *ProrationPeriodDetails `json:"prorationPeriodDetails,omitempty"` + // ForceSendFields is a list of field names (e.g. "BaseDetails") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "BaseDetails") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s OfferPhaseDetails) MarshalJSON() ([]byte, error) { + type NoMethod OfferPhaseDetails + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // OfferTag: Represents a custom tag specified for a product offer. type OfferTag struct { // Tag: Must conform with RFC-1034. That is, this string can only contain @@ -6204,6 +6333,37 @@ func (s OtherRegionsSubscriptionOfferPhasePrices) MarshalJSON() ([]byte, error) return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// OutOfAppPurchaseContext: Information specific to an out of app purchase. +type OutOfAppPurchaseContext struct { + // ExpiredExternalAccountIdentifiers: User account identifier from the last + // expired subscription for this SKU. + ExpiredExternalAccountIdentifiers *ExternalAccountIdentifiers `json:"expiredExternalAccountIdentifiers,omitempty"` + // ExpiredPurchaseToken: The purchase token of the last expired subscription. + // This purchase token must only be used to help identify the user if the link + // between the purchaseToken and user is stored in your database. This cannot + // be used to call the Google Developer API if it has been more than 60 days + // since expiry. + ExpiredPurchaseToken string `json:"expiredPurchaseToken,omitempty"` + // ForceSendFields is a list of field names (e.g. + // "ExpiredExternalAccountIdentifiers") to unconditionally include in API + // requests. By default, fields with empty or default values are omitted from + // API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. + // "ExpiredExternalAccountIdentifiers") to include in API requests with the + // JSON null value. By default, fields with empty values are omitted from API + // requests. See https://pkg.go.dev/google.golang.org/api#hdr-NullFields for + // more details. + NullFields []string `json:"-"` +} + +func (s OutOfAppPurchaseContext) MarshalJSON() ([]byte, error) { + type NoMethod OutOfAppPurchaseContext + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // PageInfo: Information about the current page. List operations that supports // paging return only one "page" of results. This protocol buffer message // describes the page that has been returned. @@ -6777,6 +6937,51 @@ func (s ProductPurchasesAcknowledgeRequest) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// ProrationPeriodDetails: Details of a proration period. A proration period +// can be a period calculated during a plan change to cover existing +// entitlements (For more information, see Allow users to upgrade, downgrade, +// or change their subscription +// (https://developer.android.com/google/play/billing/subscriptions#allow-users-change), +// or a prorated period to align add-on renewal dates with the base (For more +// information, see Rules applicable for items in the purchase +// (https://developer.android.com/google/play/billing/subscription-with-addons#rules-base-addons)). +type ProrationPeriodDetails struct { + // LinkedOrderId: The last order id of the original subscription purchase prior + // to the plan change. This is only populated if this proration period is from + // an ugrade/downgrade from a previous subscription and carries the remaining + // offer phase from the linked order of the previous subscription. + LinkedOrderId string `json:"linkedOrderId,omitempty"` + // OriginalOfferPhase: Represent the original offer phase from the purchased + // the line item if the proration period contains any of them. For example, a + // proration period from CHARGE_FULL_PRICE plan change may merge the 1st offer + // phase of the subscription offer of the new product user purchased. In this + // case, the original offer phase will be set here. + // + // Possible values: + // "OFFER_PHASE_UNSPECIFIED" - Offer phase unspecified. This value is not + // used. + // "BASE" - The order funds a base price period. + // "INTRODUCTORY" - The order funds an introductory pricing period. + // "FREE_TRIAL" - The order funds a free trial period. + OriginalOfferPhase string `json:"originalOfferPhase,omitempty"` + // ForceSendFields is a list of field names (e.g. "LinkedOrderId") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "LinkedOrderId") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s ProrationPeriodDetails) MarshalJSON() ([]byte, error) { + type NoMethod ProrationPeriodDetails + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // PurchaseOptionTaxAndComplianceSettings: Details about taxation, Google Play // policy and legal compliance for one-time product purchase options. type PurchaseOptionTaxAndComplianceSettings struct { @@ -8044,6 +8249,7 @@ type SubscriptionDetails struct { // OfferId: The offer ID for the current subscription offer. OfferId string `json:"offerId,omitempty"` // OfferPhase: The pricing phase for the billing period funded by this order. + // Deprecated. Use offer_phase_details instead. // // Possible values: // "OFFER_PHASE_UNSPECIFIED" - Offer phase unspecified. This value is not @@ -8052,6 +8258,9 @@ type SubscriptionDetails struct { // "INTRODUCTORY" - The order funds an introductory pricing period. // "FREE_TRIAL" - The order funds a free trial period. OfferPhase string `json:"offerPhase,omitempty"` + // OfferPhaseDetails: The pricing phase details for the entitlement period + // funded by this order. + OfferPhaseDetails *OfferPhaseDetails `json:"offerPhaseDetails,omitempty"` // ServicePeriodEndTime: The end of the billing period funded by this order. // This is a snapshot of the billing/service period end time at the moment the // order was processed, and should be used only for accounting. To get the @@ -8481,6 +8690,10 @@ type SubscriptionPurchaseLineItem struct { // ExpiryTime: Time at which the subscription expired or will expire unless the // access is extended (ex. renews). ExpiryTime string `json:"expiryTime,omitempty"` + // ItemReplacement: Details of the item being replaced. This field is only + // populated if this item replaced another item in a previous subscription and + // is only available for 60 days after the purchase time. + ItemReplacement *ItemReplacement `json:"itemReplacement,omitempty"` // LatestSuccessfulOrderId: The order id of the latest successful order // associated with this item. Not present if the item is not owned by the user // yet (e.g. the item being deferred replaced to). @@ -8550,6 +8763,12 @@ type SubscriptionPurchaseV2 struct { // Convert from prepaid to auto renewing subscription. * Convert from an auto // renewing subscription to prepaid. * Topup a prepaid subscription. LinkedPurchaseToken string `json:"linkedPurchaseToken,omitempty"` + // OutOfAppPurchaseContext: Additional context for out of app purchases. This + // information is only present for re-subscription purchases (subscription + // purchases made after the previous subscription of the same product has + // expired) made through the Google Play subscriptions center. This field will + // be removed after you acknowledge the subscription. + OutOfAppPurchaseContext *OutOfAppPurchaseContext `json:"outOfAppPurchaseContext,omitempty"` // PausedStateContext: Additional context around paused subscriptions. Only // present if the subscription currently has subscription_state // SUBSCRIPTION_STATE_PAUSED. @@ -8620,6 +8839,8 @@ func (s SubscriptionPurchaseV2) MarshalJSON() ([]byte, error) { type SubscriptionPurchasesAcknowledgeRequest struct { // DeveloperPayload: Payload to attach to the purchase. DeveloperPayload string `json:"developerPayload,omitempty"` + // ExternalAccountIds: Optional. User account identifier in your app. + ExternalAccountIds *ExternalAccountIds `json:"externalAccountIds,omitempty"` // ForceSendFields is a list of field names (e.g. "DeveloperPayload") to // unconditionally include in API requests. By default, fields with empty or // default values are omitted from API requests. See diff --git a/backupdr/v1/backupdr-api.json b/backupdr/v1/backupdr-api.json index 5037270a998..becb2f9a8ba 100644 --- a/backupdr/v1/backupdr-api.json +++ b/backupdr/v1/backupdr-api.json @@ -1373,12 +1373,12 @@ ], "parameters": { "filter": { - "description": "Optional. A filter expression that filters the results fetched in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. Supported fields:", + "description": "Optional. A filter expression that filters the results fetched in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. Supported fields: * name * state * backup_type * create_time * expire_time * enforced_retention_end_time * gcp_backup_plan_info.backup_plan * cloud_sql_instance_backup_properties.instance_tier * cloud_sql_instance_backup_properties.database_installed_version", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * name", "location": "query", "type": "string" }, @@ -2199,6 +2199,34 @@ }, "trial": { "methods": { + "end": { + "description": "Ends the trial for a project", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trial:end", + "httpMethod": "POST", + "id": "backupdr.projects.locations.trial.end", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource where this trial will be ended.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/trial:end", + "request": { + "$ref": "EndTrialRequest" + }, + "response": { + "$ref": "Trial" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "subscribe": { "description": "Subscribes to a trial for a project", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trial:subscribe", @@ -2234,7 +2262,7 @@ } } }, - "revision": "20251105", + "revision": "20251112", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AbandonBackupRequest": { @@ -4618,6 +4646,27 @@ }, "type": "object" }, + "EndTrialRequest": { + "description": "Request message for ending a trial.", + "id": "EndTrialRequest", + "properties": { + "endReason": { + "description": "Required. The reason for ending the trial.", + "enum": [ + "END_REASON_UNSPECIFIED", + "MOVE_TO_PAID", + "DISCONTINUED" + ], + "enumDescriptions": [ + "End reason not set.", + "Trial is deliberately ended by the user to transition to paid usage.", + "Trial is discontinued before expiration." + ], + "type": "string" + } + }, + "type": "object" + }, "Entry": { "description": "A key/value pair to be used for storing metadata.", "id": "Entry", diff --git a/backupdr/v1/backupdr-gen.go b/backupdr/v1/backupdr-gen.go index b4c3432f6ed..355711be34a 100644 --- a/backupdr/v1/backupdr-gen.go +++ b/backupdr/v1/backupdr-gen.go @@ -2805,6 +2805,34 @@ func (s EncryptionConfig) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// EndTrialRequest: Request message for ending a trial. +type EndTrialRequest struct { + // EndReason: Required. The reason for ending the trial. + // + // Possible values: + // "END_REASON_UNSPECIFIED" - End reason not set. + // "MOVE_TO_PAID" - Trial is deliberately ended by the user to transition to + // paid usage. + // "DISCONTINUED" - Trial is discontinued before expiration. + EndReason string `json:"endReason,omitempty"` + // ForceSendFields is a list of field names (e.g. "EndReason") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "EndReason") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s EndTrialRequest) MarshalJSON() ([]byte, error) { + type NoMethod EndTrialRequest + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // Entry: A key/value pair to be used for storing metadata. type Entry struct { // Key: Optional. Key for the metadata entry. @@ -9728,7 +9756,10 @@ func (r *ProjectsLocationsBackupVaultsDataSourcesBackupsService) FetchForResourc // Filter sets the optional parameter "filter": A filter expression that // filters the results fetched in the response. The expression must specify the // field name, a comparison operator, and the value that you want to use for -// filtering. Supported fields: +// filtering. Supported fields: * name * state * backup_type * create_time * +// expire_time * enforced_retention_end_time * gcp_backup_plan_info.backup_plan +// * cloud_sql_instance_backup_properties.instance_tier * +// cloud_sql_instance_backup_properties.database_installed_version func (c *ProjectsLocationsBackupVaultsDataSourcesBackupsFetchForResourceTypeCall) Filter(filter string) *ProjectsLocationsBackupVaultsDataSourcesBackupsFetchForResourceTypeCall { c.urlParams_.Set("filter", filter) return c @@ -9736,7 +9767,7 @@ func (c *ProjectsLocationsBackupVaultsDataSourcesBackupsFetchForResourceTypeCall // OrderBy sets the optional parameter "orderBy": A comma-separated list of // fields to order by, sorted in ascending order. Use "desc" after a field name -// for descending. +// for descending. Supported fields: * name func (c *ProjectsLocationsBackupVaultsDataSourcesBackupsFetchForResourceTypeCall) OrderBy(orderBy string) *ProjectsLocationsBackupVaultsDataSourcesBackupsFetchForResourceTypeCall { c.urlParams_.Set("orderBy", orderBy) return c @@ -12648,6 +12679,109 @@ func (c *ProjectsLocationsServiceConfigInitializeCall) Do(opts ...googleapi.Call return ret, nil } +type ProjectsLocationsTrialEndCall struct { + s *Service + parent string + endtrialrequest *EndTrialRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// End: Ends the trial for a project +// +// - parent: The parent resource where this trial will be ended. +func (r *ProjectsLocationsTrialService) End(parent string, endtrialrequest *EndTrialRequest) *ProjectsLocationsTrialEndCall { + c := &ProjectsLocationsTrialEndCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.parent = parent + c.endtrialrequest = endtrialrequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more +// details. +func (c *ProjectsLocationsTrialEndCall) Fields(s ...googleapi.Field) *ProjectsLocationsTrialEndCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. +func (c *ProjectsLocationsTrialEndCall) Context(ctx context.Context) *ProjectsLocationsTrialEndCall { + c.ctx_ = ctx + return c +} + +// Header returns a http.Header that can be modified by the caller to add +// headers to the request. +func (c *ProjectsLocationsTrialEndCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsTrialEndCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "application/json", c.header_) + body, err := googleapi.WithoutDataWrapper.JSONBuffer(c.endtrialrequest) + if err != nil { + return nil, err + } + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+parent}/trial:end") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "parent": c.parent, + }) + c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "backupdr.projects.locations.trial.end", "request", internallog.HTTPRequest(req, body.Bytes())) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "backupdr.projects.locations.trial.end" call. +// Any non-2xx status code is an error. Response headers are in either +// *Trial.ServerResponse.Header or (if a response was returned at all) in +// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check +// whether the returned error was because http.StatusNotModified was returned. +func (c *ProjectsLocationsTrialEndCall) Do(opts ...googleapi.CallOption) (*Trial, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Trial{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + b, err := gensupport.DecodeResponseBytes(target, res) + if err != nil { + return nil, err + } + c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "backupdr.projects.locations.trial.end", "response", internallog.HTTPResponse(res, b)) + return ret, nil +} + type ProjectsLocationsTrialSubscribeCall struct { s *Service parent string diff --git a/batch/v1/batch-api.json b/batch/v1/batch-api.json index 127856776ff..47cffbddc10 100644 --- a/batch/v1/batch-api.json +++ b/batch/v1/batch-api.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -548,7 +548,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -600,7 +600,7 @@ } } }, - "revision": "20251020", + "revision": "20251112", "rootUrl": "https://batch.googleapis.com/", "schemas": { "Accelerator": { @@ -1640,7 +1640,7 @@ "type": "array" }, "unreachable": { - "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, diff --git a/batch/v1/batch-gen.go b/batch/v1/batch-gen.go index 812a2bad419..d34000f4d45 100644 --- a/batch/v1/batch-gen.go +++ b/batch/v1/batch-gen.go @@ -1605,8 +1605,8 @@ type ListOperationsResponse struct { Operations []*Operation `json:"operations,omitempty"` // Unreachable: Unordered list. Unreachable resources. Populated when the // request sets `ListOperationsRequest.return_partial_success` and reads across - // collections e.g. when attempting to list all resources across all supported - // locations. + // collections. For example, when attempting to list all resources across all + // supported locations. Unreachable []string `json:"unreachable,omitempty"` // ServerResponse contains the HTTP response code and headers from the server. @@ -2714,9 +2714,9 @@ func (r *ProjectsLocationsService) List(name string) *ProjectsLocationsListCall return c } -// ExtraLocationTypes sets the optional parameter "extraLocationTypes": Unless -// explicitly documented otherwise, don't use this unsupported field which is -// primarily intended for internal usage. +// ExtraLocationTypes sets the optional parameter "extraLocationTypes": Do not +// use this field. It is unsupported and is ignored unless explicitly +// documented otherwise. This is primarily for internal usage. func (c *ProjectsLocationsListCall) ExtraLocationTypes(extraLocationTypes ...string) *ProjectsLocationsListCall { c.urlParams_.SetMulti("extraLocationTypes", append([]string{}, extraLocationTypes...)) return c @@ -4104,9 +4104,9 @@ func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *Proje // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsOperationsListCall { diff --git a/contactcenteraiplatform/v1alpha1/contactcenteraiplatform-api.json b/contactcenteraiplatform/v1alpha1/contactcenteraiplatform-api.json index 1522abe7435..a03cd27056e 100644 --- a/contactcenteraiplatform/v1alpha1/contactcenteraiplatform-api.json +++ b/contactcenteraiplatform/v1alpha1/contactcenteraiplatform-api.json @@ -503,7 +503,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -523,7 +523,7 @@ } } }, - "revision": "20251022", + "revision": "20251115", "rootUrl": "https://contactcenteraiplatform.googleapis.com/", "schemas": { "AdminUser": { @@ -914,7 +914,7 @@ "type": "array" }, "unreachable": { - "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, diff --git a/contactcenteraiplatform/v1alpha1/contactcenteraiplatform-gen.go b/contactcenteraiplatform/v1alpha1/contactcenteraiplatform-gen.go index c791381df48..9a7f6af4f1e 100644 --- a/contactcenteraiplatform/v1alpha1/contactcenteraiplatform-gen.go +++ b/contactcenteraiplatform/v1alpha1/contactcenteraiplatform-gen.go @@ -591,8 +591,8 @@ type ListOperationsResponse struct { Operations []*Operation `json:"operations,omitempty"` // Unreachable: Unordered list. Unreachable resources. Populated when the // request sets `ListOperationsRequest.return_partial_success` and reads across - // collections e.g. when attempting to list all resources across all supported - // locations. + // collections. For example, when attempting to list all resources across all + // supported locations. Unreachable []string `json:"unreachable,omitempty"` // ServerResponse contains the HTTP response code and headers from the server. @@ -2490,9 +2490,9 @@ func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *Proje // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsOperationsListCall { diff --git a/datamanager/v1/datamanager-api.json b/datamanager/v1/datamanager-api.json index a778e770077..b413f6347e4 100644 --- a/datamanager/v1/datamanager-api.json +++ b/datamanager/v1/datamanager-api.json @@ -193,7 +193,7 @@ } } }, - "revision": "20251105", + "revision": "20251115", "rootUrl": "https://datamanager.googleapis.com/", "schemas": { "AdIdentifiers": { @@ -285,7 +285,7 @@ "type": "string" }, "kekUri": { - "description": "Required. The URI of the AWS KMS key used to decrypt the DEK. Should be in the format of \"arn:{partition}:kms:{region}:{account_id}:key/{key_id}\"", + "description": "Required. The URI of the AWS KMS key used to decrypt the DEK. Should be in the format of `arn:{partition}:kms:{region}:{account_id}:key/{key_id}` or `aws-kms://arn:{partition}:kms:{region}:{account_id}:key/{key_id}`", "type": "string" }, "keyType": { @@ -301,7 +301,7 @@ "type": "string" }, "roleArn": { - "description": "Required. The Amazon Resource Name of the IAM Role to assume for KMS decryption access. Should be in the format of \"arn:{partition}:iam::{account_id}:role/{role_name}\"", + "description": "Required. The Amazon Resource Name of the IAM Role to assume for KMS decryption access. Should be in the format of `arn:{partition}:iam::{account_id}:role/{role_name}`", "type": "string" } }, @@ -695,7 +695,7 @@ "type": "string" }, "kekUri": { - "description": "Required. Google Cloud Platform [Cloud Key Management Service resource ID](//cloud.google.com/kms/docs/getting-resource-ids). Should be in the format of \"projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}\".", + "description": "Required. Google Cloud Platform [Cloud Key Management Service resource ID](//cloud.google.com/kms/docs/getting-resource-ids). Should be in the format of `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}` or `gcp-kms://projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}`", "type": "string" }, "keyType": { diff --git a/datamanager/v1/datamanager-gen.go b/datamanager/v1/datamanager-gen.go index c70bd4f1c87..37658d1e83e 100644 --- a/datamanager/v1/datamanager-gen.go +++ b/datamanager/v1/datamanager-gen.go @@ -292,7 +292,8 @@ type AwsWrappedKeyInfo struct { // EncryptedDek: Required. The base64 encoded encrypted data encryption key. EncryptedDek string `json:"encryptedDek,omitempty"` // KekUri: Required. The URI of the AWS KMS key used to decrypt the DEK. Should - // be in the format of "arn:{partition}:kms:{region}:{account_id}:key/{key_id}" + // be in the format of `arn:{partition}:kms:{region}:{account_id}:key/{key_id}` + // or `aws-kms://arn:{partition}:kms:{region}:{account_id}:key/{key_id}` KekUri string `json:"kekUri,omitempty"` // KeyType: Required. The type of algorithm used to encrypt the data. // @@ -302,7 +303,7 @@ type AwsWrappedKeyInfo struct { KeyType string `json:"keyType,omitempty"` // RoleArn: Required. The Amazon Resource Name of the IAM Role to assume for // KMS decryption access. Should be in the format of - // "arn:{partition}:iam::{account_id}:role/{role_name}" + // `arn:{partition}:iam::{account_id}:role/{role_name}` RoleArn string `json:"roleArn,omitempty"` // ForceSendFields is a list of field names (e.g. "EncryptedDek") to // unconditionally include in API requests. By default, fields with empty or @@ -801,8 +802,10 @@ type GcpWrappedKeyInfo struct { // KekUri: Required. Google Cloud Platform Cloud Key Management Service // resource ID (//cloud.google.com/kms/docs/getting-resource-ids). Should be in // the format of - // "projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key} - // ". + // `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key} + // ` or + // `gcp-kms://projects/{project}/locations/{location}/keyRings/{key_ring}/crypto + // Keys/{key}` KekUri string `json:"kekUri,omitempty"` // KeyType: Required. The type of algorithm used to encrypt the data. // diff --git a/developerconnect/v1/developerconnect-api.json b/developerconnect/v1/developerconnect-api.json index b5204d4e681..5734a46daa4 100644 --- a/developerconnect/v1/developerconnect-api.json +++ b/developerconnect/v1/developerconnect-api.json @@ -1586,7 +1586,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -1606,7 +1606,7 @@ } } }, - "revision": "20251030", + "revision": "20251113", "rootUrl": "https://developerconnect.googleapis.com/", "schemas": { "AccountConnector": { @@ -2644,7 +2644,7 @@ "type": "array" }, "unreachable": { - "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, diff --git a/developerconnect/v1/developerconnect-gen.go b/developerconnect/v1/developerconnect-gen.go index cd9b18da9e8..8158388a972 100644 --- a/developerconnect/v1/developerconnect-gen.go +++ b/developerconnect/v1/developerconnect-gen.go @@ -1521,8 +1521,8 @@ type ListOperationsResponse struct { Operations []*Operation `json:"operations,omitempty"` // Unreachable: Unordered list. Unreachable resources. Populated when the // request sets `ListOperationsRequest.return_partial_success` and reads across - // collections e.g. when attempting to list all resources across all supported - // locations. + // collections. For example, when attempting to list all resources across all + // supported locations. Unreachable []string `json:"unreachable,omitempty"` // ServerResponse contains the HTTP response code and headers from the server. @@ -6988,9 +6988,9 @@ func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *Proje // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsOperationsListCall { diff --git a/discoveryengine/v1/discoveryengine-api.json b/discoveryengine/v1/discoveryengine-api.json index 28a9d62c7ee..b65cf29685e 100644 --- a/discoveryengine/v1/discoveryengine-api.json +++ b/discoveryengine/v1/discoveryengine-api.json @@ -141,49 +141,6 @@ }, "protocol": "rest", "resources": { - "media": { - "methods": { - "download": { - "description": "Downloads a file from the session.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}:downloadFile", - "httpMethod": "GET", - "id": "discoveryengine.media.download", - "parameterOrder": [ - "name" - ], - "parameters": { - "fileId": { - "description": "Required. The ID of the file to be downloaded.", - "location": "query", - "type": "string" - }, - "name": { - "description": "Required. The resource name of the Session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", - "required": true, - "type": "string" - }, - "viewId": { - "description": "Optional. The ID of the view to be downloaded.", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}:downloadFile", - "response": { - "$ref": "GdataMedia" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", - "https://www.googleapis.com/auth/discoveryengine.readwrite" - ], - "supportsMediaDownload": true, - "useMediaDownloadService": true - } - } - }, "projects": { "methods": { "provision": { @@ -678,7 +635,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -1342,7 +1299,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -1915,7 +1872,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -1994,7 +1951,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -2232,7 +2189,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -2926,7 +2883,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -3274,7 +3231,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -3748,6 +3705,68 @@ "resources": { "assistants": { "methods": { + "create": { + "description": "Creates an Assistant.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.collections.engines.assistants.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "assistantId": { + "description": "Required. The ID to use for the Assistant, which will become the final component of the Assistant's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/assistants", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1Assistant" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1Assistant" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, + "delete": { + "description": "Deletes an Assistant.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}", + "httpMethod": "DELETE", + "id": "discoveryengine.projects.locations.collections.engines.assistants.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` If the caller does not have permission to delete the Assistant, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Assistant to delete does not exist, a NOT_FOUND error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, "get": { "description": "Gets an Assistant.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}", @@ -3775,6 +3794,44 @@ "https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, + "list": { + "description": "Lists all Assistants under an Engine.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.engines.assistants.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of Assistants to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token ListAssistantsResponse.next_page_token, received from a previous AssistantService.ListAssistants call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAssistants must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/assistants", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1ListAssistantsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, "patch": { "description": "Updates an Assistant", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}", @@ -3841,6 +3898,42 @@ "https://www.googleapis.com/auth/discoveryengine.readwrite" ] } + }, + "resources": { + "agents": { + "resources": { + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.engines.assistants.agents.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + } + } + } + } + } } }, "completionConfig": { @@ -4331,7 +4424,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -4945,7 +5038,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -5580,7 +5673,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -6123,7 +6216,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -6202,7 +6295,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -7812,7 +7905,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -7990,7 +8083,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -8380,8 +8473,8 @@ "parent" ], "parameters": { - "filter": { - "description": "Optional. Filter for the list request. Supported fields: * `license`_`assignment`_`state` * `user_principal` * `user_profile` Examples: * `license`_`assignment`_`state = ASSIGNED` to list assigned user licenses. * `license`_`assignment`_`state = NO_LICENSE` to list not licensed users. * `license`_`assignment`_`state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license`_`assignment`_`state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned.", + "orderBy": { + "description": "Optional. The order in which the UserLicenses are listed. The value must be a comma-separated list of fields. Default sorting order is ascending. To specify descending order for a field, append a \" desc\" suffix. Redundant space characters in the syntax are insignificant. Supported fields: * `license_assignment_state` * `user_principal` * `user_profile` * `last_login_date` * `update_time` If not set, the default ordering is by `user_principal`. Examples: * `user_principal desc` to order by `user_principal` in descending order. * `license_assignment_state` to order by `license_assignment_state` in ascending order. * `last_login_date desc` to order by `last_login_date` in descending order. * `update_time desc` to order by `update_time` in descending order. * `last_login_date desc, user_principal` to order by `last_login_date` in descending order and then by `user_principal` in ascending order.", "location": "query", "type": "string" }, @@ -8509,7 +8602,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -8528,439 +8621,9 @@ } } }, - "revision": "20251109", + "revision": "20251116", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { - "GdataBlobstore2Info": { - "description": "Information to read/write to blobstore2.", - "id": "GdataBlobstore2Info", - "properties": { - "blobGeneration": { - "description": "The blob generation id.", - "format": "int64", - "type": "string" - }, - "blobId": { - "description": "The blob id, e.g., /blobstore/prod/playground/scotty", - "type": "string" - }, - "downloadReadHandle": { - "description": "Read handle passed from Bigstore -\u003e Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.", - "format": "byte", - "type": "string" - }, - "readToken": { - "description": "The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.", - "type": "string" - }, - "uploadMetadataContainer": { - "description": "Metadata passed from Blobstore -\u003e Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.", - "format": "byte", - "type": "string" - } - }, - "type": "object" - }, - "GdataCompositeMedia": { - "description": "A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites.", - "id": "GdataCompositeMedia", - "properties": { - "blobRef": { - "deprecated": true, - "description": "Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.", - "format": "byte", - "type": "string" - }, - "blobstore2Info": { - "$ref": "GdataBlobstore2Info", - "description": "Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob." - }, - "cosmoBinaryReference": { - "description": "A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.", - "format": "byte", - "type": "string" - }, - "crc32cHash": { - "description": "crc32.c hash for the payload.", - "format": "uint32", - "type": "integer" - }, - "inline": { - "description": "Media data, set if reference_type is INLINE", - "format": "byte", - "type": "string" - }, - "length": { - "description": "Size of the data, in bytes", - "format": "int64", - "type": "string" - }, - "md5Hash": { - "description": "MD5 hash for the payload.", - "format": "byte", - "type": "string" - }, - "objectId": { - "$ref": "GdataObjectId", - "description": "Reference to a TI Blob, set if reference_type is BIGSTORE_REF." - }, - "path": { - "description": "Path to the data, set if reference_type is PATH", - "type": "string" - }, - "referenceType": { - "description": "Describes what the field reference contains.", - "enum": [ - "PATH", - "BLOB_REF", - "INLINE", - "BIGSTORE_REF", - "COSMO_BINARY_REFERENCE" - ], - "enumDescriptions": [ - "Reference contains a GFS path or a local path.", - "Reference points to a blobstore object. This could be either a v1 blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info first, since v1 is being deprecated.", - "Data is included into this proto buffer", - "Reference points to a bigstore object", - "Indicates the data is stored in cosmo_binary_reference." - ], - "type": "string" - }, - "sha1Hash": { - "description": "SHA-1 hash for the payload.", - "format": "byte", - "type": "string" - } - }, - "type": "object" - }, - "GdataContentTypeInfo": { - "description": "Detailed Content-Type information from Scotty. The Content-Type of the media will typically be filled in by the header or Scotty's best_guess, but this extended information provides the backend with more information so that it can make a better decision if needed. This is only used on media upload requests from Scotty.", - "id": "GdataContentTypeInfo", - "properties": { - "bestGuess": { - "description": "Scotty's best guess of what the content type of the file is.", - "type": "string" - }, - "fromBytes": { - "description": "The content type of the file derived by looking at specific bytes (i.e. \"magic bytes\") of the actual file.", - "type": "string" - }, - "fromFileName": { - "description": "The content type of the file derived from the file extension of the original file name used by the client.", - "type": "string" - }, - "fromHeader": { - "description": "The content type of the file as specified in the request headers, multipart headers, or RUPIO start request.", - "type": "string" - }, - "fromUrlPath": { - "description": "The content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API).", - "type": "string" - } - }, - "type": "object" - }, - "GdataDiffChecksumsResponse": { - "description": "Backend response for a Diff get checksums response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.", - "id": "GdataDiffChecksumsResponse", - "properties": { - "checksumsLocation": { - "$ref": "GdataCompositeMedia", - "description": "Exactly one of these fields must be populated. If checksums_location is filled, the server will return the corresponding contents to the user. If object_location is filled, the server will calculate the checksums based on the content there and return that to the user. For details on the format of the checksums, see http://go/scotty-diff-protocol." - }, - "chunkSizeBytes": { - "description": "The chunk size of checksums. Must be a multiple of 256KB.", - "format": "int64", - "type": "string" - }, - "objectLocation": { - "$ref": "GdataCompositeMedia", - "description": "If set, calculate the checksums based on the contents and return them to the caller." - }, - "objectSizeBytes": { - "description": "The total size of the server object.", - "format": "int64", - "type": "string" - }, - "objectVersion": { - "description": "The object version of the object the checksums are being returned for.", - "type": "string" - } - }, - "type": "object" - }, - "GdataDiffDownloadResponse": { - "description": "Backend response for a Diff download response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.", - "id": "GdataDiffDownloadResponse", - "properties": { - "objectLocation": { - "$ref": "GdataCompositeMedia", - "description": "The original object location." - } - }, - "type": "object" - }, - "GdataDiffUploadRequest": { - "description": "A Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.", - "id": "GdataDiffUploadRequest", - "properties": { - "checksumsInfo": { - "$ref": "GdataCompositeMedia", - "description": "The location of the checksums for the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received. For details on the format of the checksums, see http://go/scotty-diff-protocol." - }, - "objectInfo": { - "$ref": "GdataCompositeMedia", - "description": "The location of the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received." - }, - "objectVersion": { - "description": "The object version of the object that is the base version the incoming diff script will be applied to. This field will always be filled in.", - "type": "string" - } - }, - "type": "object" - }, - "GdataDiffUploadResponse": { - "description": "Backend response for a Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.", - "id": "GdataDiffUploadResponse", - "properties": { - "objectVersion": { - "description": "The object version of the object at the server. Must be included in the end notification response. The version in the end notification response must correspond to the new version of the object that is now stored at the server, after the upload.", - "type": "string" - }, - "originalObject": { - "$ref": "GdataCompositeMedia", - "description": "The location of the original file for a diff upload request. Must be filled in if responding to an upload start notification." - } - }, - "type": "object" - }, - "GdataDiffVersionResponse": { - "description": "Backend response for a Diff get version response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.", - "id": "GdataDiffVersionResponse", - "properties": { - "objectSizeBytes": { - "description": "The total size of the server object.", - "format": "int64", - "type": "string" - }, - "objectVersion": { - "description": "The version of the object stored at the server.", - "type": "string" - } - }, - "type": "object" - }, - "GdataDownloadParameters": { - "description": "Parameters specific to media downloads.", - "id": "GdataDownloadParameters", - "properties": { - "allowGzipCompression": { - "description": "A boolean to be returned in the response to Scotty. Allows/disallows gzip encoding of the payload content when the server thinks it's advantageous (hence, does not guarantee compression) which allows Scotty to GZip the response to the client.", - "type": "boolean" - }, - "ignoreRange": { - "description": "Determining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty.", - "type": "boolean" - } - }, - "type": "object" - }, - "GdataMedia": { - "description": "A reference to data stored on the filesystem, on GFS or in blobstore.", - "id": "GdataMedia", - "properties": { - "algorithm": { - "deprecated": true, - "description": "Deprecated, use one of explicit hash type fields instead. Algorithm used for calculating the hash. As of 2011/01/21, \"MD5\" is the only possible value for this field. New values may be added at any time.", - "type": "string" - }, - "bigstoreObjectRef": { - "deprecated": true, - "description": "Use object_id instead.", - "format": "byte", - "type": "string" - }, - "blobRef": { - "deprecated": true, - "description": "Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.", - "format": "byte", - "type": "string" - }, - "blobstore2Info": { - "$ref": "GdataBlobstore2Info", - "description": "Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob." - }, - "compositeMedia": { - "description": "A composite media composed of one or more media objects, set if reference_type is COMPOSITE_MEDIA. The media length field must be set to the sum of the lengths of all composite media objects. Note: All composite media must have length specified.", - "items": { - "$ref": "GdataCompositeMedia" - }, - "type": "array" - }, - "contentType": { - "description": "MIME type of the data", - "type": "string" - }, - "contentTypeInfo": { - "$ref": "GdataContentTypeInfo", - "description": "Extended content type information provided for Scotty uploads." - }, - "cosmoBinaryReference": { - "description": "A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.", - "format": "byte", - "type": "string" - }, - "crc32cHash": { - "description": "For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported.", - "format": "uint32", - "type": "integer" - }, - "diffChecksumsResponse": { - "$ref": "GdataDiffChecksumsResponse", - "description": "Set if reference_type is DIFF_CHECKSUMS_RESPONSE." - }, - "diffDownloadResponse": { - "$ref": "GdataDiffDownloadResponse", - "description": "Set if reference_type is DIFF_DOWNLOAD_RESPONSE." - }, - "diffUploadRequest": { - "$ref": "GdataDiffUploadRequest", - "description": "Set if reference_type is DIFF_UPLOAD_REQUEST." - }, - "diffUploadResponse": { - "$ref": "GdataDiffUploadResponse", - "description": "Set if reference_type is DIFF_UPLOAD_RESPONSE." - }, - "diffVersionResponse": { - "$ref": "GdataDiffVersionResponse", - "description": "Set if reference_type is DIFF_VERSION_RESPONSE." - }, - "downloadParameters": { - "$ref": "GdataDownloadParameters", - "description": "Parameters for a media download." - }, - "filename": { - "description": "Original file name", - "type": "string" - }, - "hash": { - "deprecated": true, - "description": "Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto\u0026q=class:Hash Hex encoded hash value of the uploaded media.", - "type": "string" - }, - "hashVerified": { - "description": "For Scotty uploads only. If a user sends a hash code and the backend has requested that Scotty verify the upload against the client hash, Scotty will perform the check on behalf of the backend and will reject it if the hashes don't match. This is set to true if Scotty performed this verification.", - "type": "boolean" - }, - "inline": { - "description": "Media data, set if reference_type is INLINE", - "format": "byte", - "type": "string" - }, - "isPotentialRetry": { - "description": "|is_potential_retry| is set false only when Scotty is certain that it has not sent the request before. When a client resumes an upload, this field must be set true in agent calls, because Scotty cannot be certain that it has never sent the request before due to potential failure in the session state persistence.", - "type": "boolean" - }, - "length": { - "description": "Size of the data, in bytes", - "format": "int64", - "type": "string" - }, - "md5Hash": { - "description": "Scotty-provided MD5 hash for an upload.", - "format": "byte", - "type": "string" - }, - "mediaId": { - "description": "Media id to forward to the operation GetMedia. Can be set if reference_type is GET_MEDIA.", - "format": "byte", - "type": "string" - }, - "objectId": { - "$ref": "GdataObjectId", - "description": "Reference to a TI Blob, set if reference_type is BIGSTORE_REF." - }, - "path": { - "description": "Path to the data, set if reference_type is PATH", - "type": "string" - }, - "referenceType": { - "description": "Describes what the field reference contains.", - "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" - ], - "enumDescriptions": [ - "Reference contains a GFS path or a local path.", - "Reference points to a blobstore object. This could be either a v1 blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info first, since v1 is being deprecated.", - "Data is included into this proto buffer", - "Data should be accessed from the current service using the operation GetMedia.", - "The content for this media object is stored across multiple partial media objects under the composite_media field.", - "Reference points to a bigstore object", - "Indicates the data is stored in diff_version_response.", - "Indicates the data is stored in diff_checksums_response.", - "Indicates the data is stored in diff_download_response.", - "Indicates the data is stored in diff_upload_request.", - "Indicates the data is stored in diff_upload_response.", - "Indicates the data is stored in cosmo_binary_reference.", - "Informs Scotty to generate a response payload with the size specified in the length field. The contents of the payload are generated by Scotty and are undefined. This is useful for testing download speeds between the user and Scotty without involving a real payload source. Note: range is not supported when using arbitrary_bytes." - ], - "type": "string" - }, - "sha1Hash": { - "description": "Scotty-provided SHA1 hash for an upload.", - "format": "byte", - "type": "string" - }, - "sha256Hash": { - "description": "Scotty-provided SHA256 hash for an upload.", - "format": "byte", - "type": "string" - }, - "timestamp": { - "description": "Time at which the media data was last updated, in milliseconds since UNIX epoch", - "format": "uint64", - "type": "string" - }, - "token": { - "description": "A unique fingerprint/version id for the media data", - "type": "string" - } - }, - "type": "object" - }, - "GdataObjectId": { - "description": "This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763.", - "id": "GdataObjectId", - "properties": { - "bucketName": { - "description": "The name of the bucket to which this object belongs.", - "type": "string" - }, - "generation": { - "description": "Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions", - "format": "int64", - "type": "string" - }, - "objectName": { - "description": "The name of the object.", - "type": "string" - } - }, - "type": "object" - }, "GoogleApiDistribution": { "description": "`Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless.", "id": "GoogleApiDistribution", @@ -11183,6 +10846,14 @@ "$ref": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicy", "description": "Optional. Customer policy for the assistant." }, + "description": { + "description": "Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.", + "type": "string" + }, + "displayName": { + "description": "Required. The assistant display name. It must be a UTF-8 encoded string with a length limit of 128 characters.", + "type": "string" + }, "enabledTools": { "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1AssistantToolList" @@ -11401,10 +11072,21 @@ "description": "Configuration for the generation of the assistant response.", "id": "GoogleCloudDiscoveryengineV1AssistantGenerationConfig", "properties": { + "allowedModelIds": { + "description": "Optional. The list of models that are allowed to be used for assistant.", + "items": { + "type": "string" + }, + "type": "array" + }, "defaultLanguage": { "description": "The default language to use for the generation of the assistant response. Use an ISO 639-1 language code such as `en`. If not specified, the language will be automatically detected.", "type": "string" }, + "defaultModelId": { + "description": "Optional. The default model to use for assistant.", + "type": "string" + }, "systemInstruction": { "$ref": "GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction", "description": "System instruction, also known as the prompt preamble for LLM calls. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions" @@ -15698,6 +15380,24 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1ListAssistantsResponse": { + "description": "Response message for the AssistantService.ListAssistants method.", + "id": "GoogleCloudDiscoveryengineV1ListAssistantsResponse", + "properties": { + "assistants": { + "description": "All the customer's Assistants.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1Assistant" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token that can be sent as ListAssistantsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1ListCmekConfigsResponse": { "description": "Response message for CmekConfigService.ListCmekConfigs method.", "id": "GoogleCloudDiscoveryengineV1ListCmekConfigsResponse", @@ -16858,6 +16558,13 @@ "$ref": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec", "description": "A specification for configuring the behavior of content search." }, + "crowdingSpecs": { + "description": "Optional. Crowding specifications for improving result diversity. If multiple CrowdingSpecs are specified, crowding will be evaluated on each unique combination of the `field` values, and max_count will be the maximum value of `max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec has `field` = \"color\" and `max_count` = 3, and the second CrowdingSpec has `field` = \"size\" and `max_count` = 2, then after 3 documents that share the same color AND size have been returned, subsequent ones should be removed or demoted.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec" + }, + "type": "array" + }, "dataStoreSpecs": { "description": "Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", "items": { @@ -16906,6 +16613,13 @@ "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" }, + "pageCategories": { + "description": "Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. To represent full path of a category, use '\u003e' character to separate different hierarchies. If '\u003e' is part of the category name, replace it with other character(s). For example, `Graphics Cards \u003e RTX\u003e4090 \u003e Founders Edition` where \"RTX \u003e 4090\" represents one level, can be rewritten as `Graphics Cards \u003e RTX_4090 \u003e Founders Edition`", + "items": { + "type": "string" + }, + "type": "array" + }, "pageSize": { "description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.", "format": "int32", @@ -17290,6 +17004,36 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec": { + "description": "Specification for crowding. Crowding improves the diversity of search results by limiting the number of results that share the same field value. For example, crowding on the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will return at most 3 results with the same color across all pages.", + "id": "GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec", + "properties": { + "field": { + "description": "The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.", + "type": "string" + }, + "maxCount": { + "description": "The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in `order_by`), later results with the same value are \"crowded away\". If not specified, the default value is 1.", + "format": "int32", + "type": "integer" + }, + "mode": { + "description": "Mode to use for documents that are crowded away.", + "enum": [ + "MODE_UNSPECIFIED", + "DROP_CROWDED_RESULTS", + "DEMOTE_CROWDED_RESULTS_TO_END" + ], + "enumDescriptions": [ + "Unspecified crowding mode. In this case, server behavior defaults to Mode.DROP_CROWDED_RESULTS.", + "Drop crowded results.", + "Demote crowded results to the later pages." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec": { "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.", "id": "GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec", @@ -18486,6 +18230,13 @@ "description": "A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support.", "type": "string" }, + "invocationTools": { + "description": "The tool names of the tools that were invoked.", + "items": { + "type": "string" + }, + "type": "array" + }, "sessionInfo": { "$ref": "GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo", "description": "Session information. Only included in the final StreamAssistResponse of the response stream." @@ -25158,6 +24909,13 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", "description": "A specification for configuring the behavior of content search." }, + "crowdingSpecs": { + "description": "Optional. Crowding specifications for improving result diversity. If multiple CrowdingSpecs are specified, crowding will be evaluated on each unique combination of the `field` values, and max_count will be the maximum value of `max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec has `field` = \"color\" and `max_count` = 3, and the second CrowdingSpec has `field` = \"size\" and `max_count` = 2, then after 3 documents that share the same color AND size have been returned, subsequent ones should be removed or demoted.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec" + }, + "type": "array" + }, "customFineTuningSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", "description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec." @@ -25214,6 +24972,13 @@ "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" }, + "pageCategories": { + "description": "Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. To represent full path of a category, use '\u003e' character to separate different hierarchies. If '\u003e' is part of the category name, replace it with other character(s). For example, `Graphics Cards \u003e RTX\u003e4090 \u003e Founders Edition` where \"RTX \u003e 4090\" represents one level, can be rewritten as `Graphics Cards \u003e RTX_4090 \u003e Founders Edition`", + "items": { + "type": "string" + }, + "type": "array" + }, "pageSize": { "description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.", "format": "int32", @@ -25645,6 +25410,36 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec": { + "description": "Specification for crowding. Crowding improves the diversity of search results by limiting the number of results that share the same field value. For example, crowding on the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will return at most 3 results with the same color across all pages.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec", + "properties": { + "field": { + "description": "The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.", + "type": "string" + }, + "maxCount": { + "description": "The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in `order_by`), later results with the same value are \"crowded away\". If not specified, the default value is 1.", + "format": "int32", + "type": "integer" + }, + "mode": { + "description": "Mode to use for documents that are crowded away.", + "enum": [ + "MODE_UNSPECIFIED", + "DROP_CROWDED_RESULTS", + "DEMOTE_CROWDED_RESULTS_TO_END" + ], + "enumDescriptions": [ + "Unspecified crowding mode. In this case, server behavior defaults to Mode.DROP_CROWDED_RESULTS.", + "Drop crowded results.", + "Demote crowded results to the later pages." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec": { "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec", @@ -29135,6 +28930,13 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec", "description": "A specification for configuring the behavior of content search." }, + "crowdingSpecs": { + "description": "Optional. Crowding specifications for improving result diversity. If multiple CrowdingSpecs are specified, crowding will be evaluated on each unique combination of the `field` values, and max_count will be the maximum value of `max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec has `field` = \"color\" and `max_count` = 3, and the second CrowdingSpec has `field` = \"size\" and `max_count` = 2, then after 3 documents that share the same color AND size have been returned, subsequent ones should be removed or demoted.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec" + }, + "type": "array" + }, "dataStoreSpecs": { "description": "Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", "items": { @@ -29187,6 +28989,13 @@ "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" }, + "pageCategories": { + "description": "Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. To represent full path of a category, use '\u003e' character to separate different hierarchies. If '\u003e' is part of the category name, replace it with other character(s). For example, `Graphics Cards \u003e RTX\u003e4090 \u003e Founders Edition` where \"RTX \u003e 4090\" represents one level, can be rewritten as `Graphics Cards \u003e RTX_4090 \u003e Founders Edition`", + "items": { + "type": "string" + }, + "type": "array" + }, "pageSize": { "description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.", "format": "int32", @@ -29614,6 +29423,36 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec": { + "description": "Specification for crowding. Crowding improves the diversity of search results by limiting the number of results that share the same field value. For example, crowding on the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will return at most 3 results with the same color across all pages.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec", + "properties": { + "field": { + "description": "The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.", + "type": "string" + }, + "maxCount": { + "description": "The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in `order_by`), later results with the same value are \"crowded away\". If not specified, the default value is 1.", + "format": "int32", + "type": "integer" + }, + "mode": { + "description": "Mode to use for documents that are crowded away.", + "enum": [ + "MODE_UNSPECIFIED", + "DROP_CROWDED_RESULTS", + "DEMOTE_CROWDED_RESULTS_TO_END" + ], + "enumDescriptions": [ + "Unspecified crowding mode. In this case, server behavior defaults to Mode.DROP_CROWDED_RESULTS.", + "Drop crowded results.", + "Demote crowded results to the later pages." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec": { "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec", @@ -30444,7 +30283,7 @@ "type": "array" }, "unreachable": { - "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, diff --git a/discoveryengine/v1/discoveryengine-gen.go b/discoveryengine/v1/discoveryengine-gen.go index 2b3e686d28f..e6ac7b7cae1 100644 --- a/discoveryengine/v1/discoveryengine-gen.go +++ b/discoveryengine/v1/discoveryengine-gen.go @@ -141,7 +141,6 @@ func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, err return nil, err } s := &Service{client: client, BasePath: basePath, logger: internaloption.GetLogger(opts)} - s.Media = NewMediaService(s) s.Projects = NewProjectsService(s) if endpoint != "" { s.BasePath = endpoint @@ -167,8 +166,6 @@ type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment - Media *MediaService - Projects *ProjectsService } @@ -179,15 +176,6 @@ func (s *Service) userAgent() string { return googleapi.UserAgent + " " + s.UserAgent } -func NewMediaService(s *Service) *MediaService { - rs := &MediaService{s: s} - return rs -} - -type MediaService struct { - s *Service -} - func NewProjectsService(s *Service) *ProjectsService { rs := &ProjectsService{s: s} rs.Locations = NewProjectsLocationsService(s) @@ -628,11 +616,35 @@ type ProjectsLocationsCollectionsEnginesService struct { func NewProjectsLocationsCollectionsEnginesAssistantsService(s *Service) *ProjectsLocationsCollectionsEnginesAssistantsService { rs := &ProjectsLocationsCollectionsEnginesAssistantsService{s: s} + rs.Agents = NewProjectsLocationsCollectionsEnginesAssistantsAgentsService(s) return rs } type ProjectsLocationsCollectionsEnginesAssistantsService struct { s *Service + + Agents *ProjectsLocationsCollectionsEnginesAssistantsAgentsService +} + +func NewProjectsLocationsCollectionsEnginesAssistantsAgentsService(s *Service) *ProjectsLocationsCollectionsEnginesAssistantsAgentsService { + rs := &ProjectsLocationsCollectionsEnginesAssistantsAgentsService{s: s} + rs.Operations = NewProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsService(s) + return rs +} + +type ProjectsLocationsCollectionsEnginesAssistantsAgentsService struct { + s *Service + + Operations *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsService +} + +func NewProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsService(s *Service) *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsService { + rs := &ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsService{s: s} + return rs +} + +type ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsService struct { + s *Service } func NewProjectsLocationsCollectionsEnginesCompletionConfigService(s *Service) *ProjectsLocationsCollectionsEnginesCompletionConfigService { @@ -1097,502 +1109,6 @@ type ProjectsOperationsService struct { s *Service } -// GdataBlobstore2Info: Information to read/write to blobstore2. -type GdataBlobstore2Info struct { - // BlobGeneration: The blob generation id. - BlobGeneration int64 `json:"blobGeneration,omitempty,string"` - // BlobId: The blob id, e.g., /blobstore/prod/playground/scotty - BlobId string `json:"blobId,omitempty"` - // DownloadReadHandle: Read handle passed from Bigstore -> Scotty for a GCS - // download. This is a signed, serialized blobstore2.ReadHandle proto which - // must never be set outside of Bigstore, and is not applicable to non-GCS - // media downloads. - DownloadReadHandle string `json:"downloadReadHandle,omitempty"` - // ReadToken: The blob read token. Needed to read blobs that have not been - // replicated. Might not be available until the final call. - ReadToken string `json:"readToken,omitempty"` - // UploadMetadataContainer: Metadata passed from Blobstore -> Scotty for a new - // GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer - // proto which must never be consumed outside of Bigstore, and is not - // applicable to non-GCS media uploads. - UploadMetadataContainer string `json:"uploadMetadataContainer,omitempty"` - // ForceSendFields is a list of field names (e.g. "BlobGeneration") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "BlobGeneration") to include in - // API requests with the JSON null value. By default, fields with empty values - // are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataBlobstore2Info) MarshalJSON() ([]byte, error) { - type NoMethod GdataBlobstore2Info - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GdataCompositeMedia: A sequence of media data references representing -// composite data. Introduced to support Bigstore composite objects. For -// details, visit http://go/bigstore-composites. -type GdataCompositeMedia struct { - // BlobRef: Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This - // should be the byte representation of a blobstore.BlobRef. Since Blobstore is - // deprecating v1, use blobstore2_info instead. For now, any v2 blob will also - // be represented in this field as v1 BlobRef. - BlobRef string `json:"blobRef,omitempty"` - // Blobstore2Info: Blobstore v2 info, set if reference_type is BLOBSTORE_REF - // and it refers to a v2 blob. - Blobstore2Info *GdataBlobstore2Info `json:"blobstore2Info,omitempty"` - // CosmoBinaryReference: A binary data reference for a media download. Serves - // as a technology-agnostic binary reference in some Google infrastructure. - // This value is a serialized storage_cosmo.BinaryReference proto. Storing it - // as bytes is a hack to get around the fact that the cosmo proto (as well as - // others it includes) doesn't support JavaScript. This prevents us from - // including the actual type of this field. - CosmoBinaryReference string `json:"cosmoBinaryReference,omitempty"` - // Crc32cHash: crc32.c hash for the payload. - Crc32cHash int64 `json:"crc32cHash,omitempty"` - // Inline: Media data, set if reference_type is INLINE - Inline string `json:"inline,omitempty"` - // Length: Size of the data, in bytes - Length int64 `json:"length,omitempty,string"` - // Md5Hash: MD5 hash for the payload. - Md5Hash string `json:"md5Hash,omitempty"` - // ObjectId: Reference to a TI Blob, set if reference_type is BIGSTORE_REF. - ObjectId *GdataObjectId `json:"objectId,omitempty"` - // Path: Path to the data, set if reference_type is PATH - Path string `json:"path,omitempty"` - // ReferenceType: Describes what the field reference contains. - // - // Possible values: - // "PATH" - Reference contains a GFS path or a local path. - // "BLOB_REF" - Reference points to a blobstore object. This could be either - // a v1 blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info - // first, since v1 is being deprecated. - // "INLINE" - Data is included into this proto buffer - // "BIGSTORE_REF" - Reference points to a bigstore object - // "COSMO_BINARY_REFERENCE" - Indicates the data is stored in - // cosmo_binary_reference. - ReferenceType string `json:"referenceType,omitempty"` - // Sha1Hash: SHA-1 hash for the payload. - Sha1Hash string `json:"sha1Hash,omitempty"` - // ForceSendFields is a list of field names (e.g. "BlobRef") to unconditionally - // include in API requests. By default, fields with empty or default values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "BlobRef") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataCompositeMedia) MarshalJSON() ([]byte, error) { - type NoMethod GdataCompositeMedia - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GdataContentTypeInfo: Detailed Content-Type information from Scotty. The -// Content-Type of the media will typically be filled in by the header or -// Scotty's best_guess, but this extended information provides the backend with -// more information so that it can make a better decision if needed. This is -// only used on media upload requests from Scotty. -type GdataContentTypeInfo struct { - // BestGuess: Scotty's best guess of what the content type of the file is. - BestGuess string `json:"bestGuess,omitempty"` - // FromBytes: The content type of the file derived by looking at specific bytes - // (i.e. "magic bytes") of the actual file. - FromBytes string `json:"fromBytes,omitempty"` - // FromFileName: The content type of the file derived from the file extension - // of the original file name used by the client. - FromFileName string `json:"fromFileName,omitempty"` - // FromHeader: The content type of the file as specified in the request - // headers, multipart headers, or RUPIO start request. - FromHeader string `json:"fromHeader,omitempty"` - // FromUrlPath: The content type of the file derived from the file extension of - // the URL path. The URL path is assumed to represent a file name (which is - // typically only true for agents that are providing a REST API). - FromUrlPath string `json:"fromUrlPath,omitempty"` - // ForceSendFields is a list of field names (e.g. "BestGuess") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "BestGuess") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataContentTypeInfo) MarshalJSON() ([]byte, error) { - type NoMethod GdataContentTypeInfo - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GdataDiffChecksumsResponse: Backend response for a Diff get checksums -// response. For details on the Scotty Diff protocol, visit -// http://go/scotty-diff-protocol. -type GdataDiffChecksumsResponse struct { - // ChecksumsLocation: Exactly one of these fields must be populated. If - // checksums_location is filled, the server will return the corresponding - // contents to the user. If object_location is filled, the server will - // calculate the checksums based on the content there and return that to the - // user. For details on the format of the checksums, see - // http://go/scotty-diff-protocol. - ChecksumsLocation *GdataCompositeMedia `json:"checksumsLocation,omitempty"` - // ChunkSizeBytes: The chunk size of checksums. Must be a multiple of 256KB. - ChunkSizeBytes int64 `json:"chunkSizeBytes,omitempty,string"` - // ObjectLocation: If set, calculate the checksums based on the contents and - // return them to the caller. - ObjectLocation *GdataCompositeMedia `json:"objectLocation,omitempty"` - // ObjectSizeBytes: The total size of the server object. - ObjectSizeBytes int64 `json:"objectSizeBytes,omitempty,string"` - // ObjectVersion: The object version of the object the checksums are being - // returned for. - ObjectVersion string `json:"objectVersion,omitempty"` - // ForceSendFields is a list of field names (e.g. "ChecksumsLocation") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "ChecksumsLocation") to include in - // API requests with the JSON null value. By default, fields with empty values - // are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataDiffChecksumsResponse) MarshalJSON() ([]byte, error) { - type NoMethod GdataDiffChecksumsResponse - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GdataDiffDownloadResponse: Backend response for a Diff download response. -// For details on the Scotty Diff protocol, visit -// http://go/scotty-diff-protocol. -type GdataDiffDownloadResponse struct { - // ObjectLocation: The original object location. - ObjectLocation *GdataCompositeMedia `json:"objectLocation,omitempty"` - // ForceSendFields is a list of field names (e.g. "ObjectLocation") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "ObjectLocation") to include in - // API requests with the JSON null value. By default, fields with empty values - // are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataDiffDownloadResponse) MarshalJSON() ([]byte, error) { - type NoMethod GdataDiffDownloadResponse - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GdataDiffUploadRequest: A Diff upload request. For details on the Scotty -// Diff protocol, visit http://go/scotty-diff-protocol. -type GdataDiffUploadRequest struct { - // ChecksumsInfo: The location of the checksums for the new object. Agents must - // clone the object located here, as the upload server will delete the contents - // once a response is received. For details on the format of the checksums, see - // http://go/scotty-diff-protocol. - ChecksumsInfo *GdataCompositeMedia `json:"checksumsInfo,omitempty"` - // ObjectInfo: The location of the new object. Agents must clone the object - // located here, as the upload server will delete the contents once a response - // is received. - ObjectInfo *GdataCompositeMedia `json:"objectInfo,omitempty"` - // ObjectVersion: The object version of the object that is the base version the - // incoming diff script will be applied to. This field will always be filled - // in. - ObjectVersion string `json:"objectVersion,omitempty"` - // ForceSendFields is a list of field names (e.g. "ChecksumsInfo") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "ChecksumsInfo") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataDiffUploadRequest) MarshalJSON() ([]byte, error) { - type NoMethod GdataDiffUploadRequest - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GdataDiffUploadResponse: Backend response for a Diff upload request. For -// details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. -type GdataDiffUploadResponse struct { - // ObjectVersion: The object version of the object at the server. Must be - // included in the end notification response. The version in the end - // notification response must correspond to the new version of the object that - // is now stored at the server, after the upload. - ObjectVersion string `json:"objectVersion,omitempty"` - // OriginalObject: The location of the original file for a diff upload request. - // Must be filled in if responding to an upload start notification. - OriginalObject *GdataCompositeMedia `json:"originalObject,omitempty"` - // ForceSendFields is a list of field names (e.g. "ObjectVersion") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "ObjectVersion") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataDiffUploadResponse) MarshalJSON() ([]byte, error) { - type NoMethod GdataDiffUploadResponse - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GdataDiffVersionResponse: Backend response for a Diff get version response. -// For details on the Scotty Diff protocol, visit -// http://go/scotty-diff-protocol. -type GdataDiffVersionResponse struct { - // ObjectSizeBytes: The total size of the server object. - ObjectSizeBytes int64 `json:"objectSizeBytes,omitempty,string"` - // ObjectVersion: The version of the object stored at the server. - ObjectVersion string `json:"objectVersion,omitempty"` - // ForceSendFields is a list of field names (e.g. "ObjectSizeBytes") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "ObjectSizeBytes") to include in - // API requests with the JSON null value. By default, fields with empty values - // are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataDiffVersionResponse) MarshalJSON() ([]byte, error) { - type NoMethod GdataDiffVersionResponse - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GdataDownloadParameters: Parameters specific to media downloads. -type GdataDownloadParameters struct { - // AllowGzipCompression: A boolean to be returned in the response to Scotty. - // Allows/disallows gzip encoding of the payload content when the server thinks - // it's advantageous (hence, does not guarantee compression) which allows - // Scotty to GZip the response to the client. - AllowGzipCompression bool `json:"allowGzipCompression,omitempty"` - // IgnoreRange: Determining whether or not Apiary should skip the inclusion of - // any Content-Range header on its response to Scotty. - IgnoreRange bool `json:"ignoreRange,omitempty"` - // ForceSendFields is a list of field names (e.g. "AllowGzipCompression") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "AllowGzipCompression") to include - // in API requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataDownloadParameters) MarshalJSON() ([]byte, error) { - type NoMethod GdataDownloadParameters - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GdataMedia: A reference to data stored on the filesystem, on GFS or in -// blobstore. -type GdataMedia struct { - // Algorithm: Deprecated, use one of explicit hash type fields instead. - // Algorithm used for calculating the hash. As of 2011/01/21, "MD5" is the only - // possible value for this field. New values may be added at any time. - Algorithm string `json:"algorithm,omitempty"` - // BigstoreObjectRef: Use object_id instead. - BigstoreObjectRef string `json:"bigstoreObjectRef,omitempty"` - // BlobRef: Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This - // should be the byte representation of a blobstore.BlobRef. Since Blobstore is - // deprecating v1, use blobstore2_info instead. For now, any v2 blob will also - // be represented in this field as v1 BlobRef. - BlobRef string `json:"blobRef,omitempty"` - // Blobstore2Info: Blobstore v2 info, set if reference_type is BLOBSTORE_REF - // and it refers to a v2 blob. - Blobstore2Info *GdataBlobstore2Info `json:"blobstore2Info,omitempty"` - // CompositeMedia: A composite media composed of one or more media objects, set - // if reference_type is COMPOSITE_MEDIA. The media length field must be set to - // the sum of the lengths of all composite media objects. Note: All composite - // media must have length specified. - CompositeMedia []*GdataCompositeMedia `json:"compositeMedia,omitempty"` - // ContentType: MIME type of the data - ContentType string `json:"contentType,omitempty"` - // ContentTypeInfo: Extended content type information provided for Scotty - // uploads. - ContentTypeInfo *GdataContentTypeInfo `json:"contentTypeInfo,omitempty"` - // CosmoBinaryReference: A binary data reference for a media download. Serves - // as a technology-agnostic binary reference in some Google infrastructure. - // This value is a serialized storage_cosmo.BinaryReference proto. Storing it - // as bytes is a hack to get around the fact that the cosmo proto (as well as - // others it includes) doesn't support JavaScript. This prevents us from - // including the actual type of this field. - CosmoBinaryReference string `json:"cosmoBinaryReference,omitempty"` - // Crc32cHash: For Scotty Uploads: Scotty-provided hashes for uploads For - // Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY - // TEAM.) A Hash provided by the agent to be used to verify the data being - // downloaded. Currently only supported for inline payloads. Further, only - // crc32c_hash is currently supported. - Crc32cHash int64 `json:"crc32cHash,omitempty"` - // DiffChecksumsResponse: Set if reference_type is DIFF_CHECKSUMS_RESPONSE. - DiffChecksumsResponse *GdataDiffChecksumsResponse `json:"diffChecksumsResponse,omitempty"` - // DiffDownloadResponse: Set if reference_type is DIFF_DOWNLOAD_RESPONSE. - DiffDownloadResponse *GdataDiffDownloadResponse `json:"diffDownloadResponse,omitempty"` - // DiffUploadRequest: Set if reference_type is DIFF_UPLOAD_REQUEST. - DiffUploadRequest *GdataDiffUploadRequest `json:"diffUploadRequest,omitempty"` - // DiffUploadResponse: Set if reference_type is DIFF_UPLOAD_RESPONSE. - DiffUploadResponse *GdataDiffUploadResponse `json:"diffUploadResponse,omitempty"` - // DiffVersionResponse: Set if reference_type is DIFF_VERSION_RESPONSE. - DiffVersionResponse *GdataDiffVersionResponse `json:"diffVersionResponse,omitempty"` - // DownloadParameters: Parameters for a media download. - DownloadParameters *GdataDownloadParameters `json:"downloadParameters,omitempty"` - // Filename: Original file name - Filename string `json:"filename,omitempty"` - // Hash: Deprecated, use one of explicit hash type fields instead. These two - // hash related fields will only be populated on Scotty based media uploads and - // will contain the content of the hash group in the NotificationRequest: - // http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash - // Hex encoded hash value of the uploaded media. - Hash string `json:"hash,omitempty"` - // HashVerified: For Scotty uploads only. If a user sends a hash code and the - // backend has requested that Scotty verify the upload against the client hash, - // Scotty will perform the check on behalf of the backend and will reject it if - // the hashes don't match. This is set to true if Scotty performed this - // verification. - HashVerified bool `json:"hashVerified,omitempty"` - // Inline: Media data, set if reference_type is INLINE - Inline string `json:"inline,omitempty"` - // IsPotentialRetry: |is_potential_retry| is set false only when Scotty is - // certain that it has not sent the request before. When a client resumes an - // upload, this field must be set true in agent calls, because Scotty cannot be - // certain that it has never sent the request before due to potential failure - // in the session state persistence. - IsPotentialRetry bool `json:"isPotentialRetry,omitempty"` - // Length: Size of the data, in bytes - Length int64 `json:"length,omitempty,string"` - // Md5Hash: Scotty-provided MD5 hash for an upload. - Md5Hash string `json:"md5Hash,omitempty"` - // MediaId: Media id to forward to the operation GetMedia. Can be set if - // reference_type is GET_MEDIA. - MediaId string `json:"mediaId,omitempty"` - // ObjectId: Reference to a TI Blob, set if reference_type is BIGSTORE_REF. - ObjectId *GdataObjectId `json:"objectId,omitempty"` - // Path: Path to the data, set if reference_type is PATH - Path string `json:"path,omitempty"` - // ReferenceType: Describes what the field reference contains. - // - // Possible values: - // "PATH" - Reference contains a GFS path or a local path. - // "BLOB_REF" - Reference points to a blobstore object. This could be either - // a v1 blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info - // first, since v1 is being deprecated. - // "INLINE" - Data is included into this proto buffer - // "GET_MEDIA" - Data should be accessed from the current service using the - // operation GetMedia. - // "COMPOSITE_MEDIA" - The content for this media object is stored across - // multiple partial media objects under the composite_media field. - // "BIGSTORE_REF" - Reference points to a bigstore object - // "DIFF_VERSION_RESPONSE" - Indicates the data is stored in - // diff_version_response. - // "DIFF_CHECKSUMS_RESPONSE" - Indicates the data is stored in - // diff_checksums_response. - // "DIFF_DOWNLOAD_RESPONSE" - Indicates the data is stored in - // diff_download_response. - // "DIFF_UPLOAD_REQUEST" - Indicates the data is stored in - // diff_upload_request. - // "DIFF_UPLOAD_RESPONSE" - Indicates the data is stored in - // diff_upload_response. - // "COSMO_BINARY_REFERENCE" - Indicates the data is stored in - // cosmo_binary_reference. - // "ARBITRARY_BYTES" - Informs Scotty to generate a response payload with the - // size specified in the length field. The contents of the payload are - // generated by Scotty and are undefined. This is useful for testing download - // speeds between the user and Scotty without involving a real payload source. - // Note: range is not supported when using arbitrary_bytes. - ReferenceType string `json:"referenceType,omitempty"` - // Sha1Hash: Scotty-provided SHA1 hash for an upload. - Sha1Hash string `json:"sha1Hash,omitempty"` - // Sha256Hash: Scotty-provided SHA256 hash for an upload. - Sha256Hash string `json:"sha256Hash,omitempty"` - // Timestamp: Time at which the media data was last updated, in milliseconds - // since UNIX epoch - Timestamp uint64 `json:"timestamp,omitempty,string"` - // Token: A unique fingerprint/version id for the media data - Token string `json:"token,omitempty"` - - // ServerResponse contains the HTTP response code and headers from the server. - googleapi.ServerResponse `json:"-"` - // ForceSendFields is a list of field names (e.g. "Algorithm") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Algorithm") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataMedia) MarshalJSON() ([]byte, error) { - type NoMethod GdataMedia - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GdataObjectId: This is a copy of the tech.blob.ObjectId proto, which could -// not be used directly here due to transitive closure issues with JavaScript -// support; see http://b/8801763. -type GdataObjectId struct { - // BucketName: The name of the bucket to which this object belongs. - BucketName string `json:"bucketName,omitempty"` - // Generation: Generation of the object. Generations are monotonically - // increasing across writes, allowing them to be be compared to determine which - // generation is newer. If this is omitted in a request, then you are - // requesting the live object. See http://go/bigstore-versions - Generation int64 `json:"generation,omitempty,string"` - // ObjectName: The name of the object. - ObjectName string `json:"objectName,omitempty"` - // ForceSendFields is a list of field names (e.g. "BucketName") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "BucketName") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataObjectId) MarshalJSON() ([]byte, error) { - type NoMethod GdataObjectId - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - // GoogleApiDistribution: `Distribution` contains summary statistics for a // population of values. It optionally contains a histogram representing the // distribution of those values across a set of buckets. The summary statistics @@ -4786,6 +4302,12 @@ func (s GoogleCloudDiscoveryengineV1AssistUserMetadata) MarshalJSON() ([]byte, e type GoogleCloudDiscoveryengineV1Assistant struct { // CustomerPolicy: Optional. Customer policy for the assistant. CustomerPolicy *GoogleCloudDiscoveryengineV1AssistantCustomerPolicy `json:"customerPolicy,omitempty"` + // Description: Optional. Description for additional information. Expected to + // be shown on the configuration UI, not to the users of the assistant. + Description string `json:"description,omitempty"` + // DisplayName: Required. The assistant display name. It must be a UTF-8 + // encoded string with a length limit of 128 characters. + DisplayName string `json:"displayName,omitempty"` // EnabledTools: Optional. Note: not implemented yet. Use enabled_actions // instead. The enabled tools on this assistant. The keys are connector name, // for example @@ -5087,21 +4609,26 @@ func (s GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig) Mar // GoogleCloudDiscoveryengineV1AssistantGenerationConfig: Configuration for the // generation of the assistant response. type GoogleCloudDiscoveryengineV1AssistantGenerationConfig struct { + // AllowedModelIds: Optional. The list of models that are allowed to be used + // for assistant. + AllowedModelIds []string `json:"allowedModelIds,omitempty"` // DefaultLanguage: The default language to use for the generation of the // assistant response. Use an ISO 639-1 language code such as `en`. If not // specified, the language will be automatically detected. DefaultLanguage string `json:"defaultLanguage,omitempty"` + // DefaultModelId: Optional. The default model to use for assistant. + DefaultModelId string `json:"defaultModelId,omitempty"` // SystemInstruction: System instruction, also known as the prompt preamble for // LLM calls. See also // https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions SystemInstruction *GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction `json:"systemInstruction,omitempty"` - // ForceSendFields is a list of field names (e.g. "DefaultLanguage") to + // ForceSendFields is a list of field names (e.g. "AllowedModelIds") to // unconditionally include in API requests. By default, fields with empty or // default values are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "DefaultLanguage") to include in + // NullFields is a list of field names (e.g. "AllowedModelIds") to include in // API requests with the JSON null value. By default, fields with empty values // are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. @@ -10768,6 +10295,36 @@ func (s GoogleCloudDiscoveryengineV1LicenseConfigUsageStats) MarshalJSON() ([]by return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1ListAssistantsResponse: Response message for the +// AssistantService.ListAssistants method. +type GoogleCloudDiscoveryengineV1ListAssistantsResponse struct { + // Assistants: All the customer's Assistants. + Assistants []*GoogleCloudDiscoveryengineV1Assistant `json:"assistants,omitempty"` + // NextPageToken: A token that can be sent as ListAssistantsRequest.page_token + // to retrieve the next page. If this field is omitted, there are no subsequent + // pages. + NextPageToken string `json:"nextPageToken,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the server. + googleapi.ServerResponse `json:"-"` + // ForceSendFields is a list of field names (e.g. "Assistants") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Assistants") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1ListAssistantsResponse) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1ListAssistantsResponse + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1ListCmekConfigsResponse: Response message for // CmekConfigService.ListCmekConfigs method. type GoogleCloudDiscoveryengineV1ListCmekConfigsResponse struct { @@ -12550,6 +12107,15 @@ type GoogleCloudDiscoveryengineV1SearchRequest struct { // ContentSearchSpec: A specification for configuring the behavior of content // search. ContentSearchSpec *GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec `json:"contentSearchSpec,omitempty"` + // CrowdingSpecs: Optional. Crowding specifications for improving result + // diversity. If multiple CrowdingSpecs are specified, crowding will be + // evaluated on each unique combination of the `field` values, and max_count + // will be the maximum value of `max_count` across all CrowdingSpecs. For + // example, if the first CrowdingSpec has `field` = "color" and `max_count` = + // 3, and the second CrowdingSpec has `field` = "size" and `max_count` = 2, + // then after 3 documents that share the same color AND size have been + // returned, subsequent ones should be removed or demoted. + CrowdingSpecs []*GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec `json:"crowdingSpecs,omitempty"` // DataStoreSpecs: Specifications that define the specific DataStores to be // searched, along with configurations for those data stores. This is only // considered for Engines with multiple data stores. For engines with a single @@ -12608,6 +12174,17 @@ type GoogleCloudDiscoveryengineV1SearchRequest struct { // (https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). // If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. OrderBy string `json:"orderBy,omitempty"` + // PageCategories: Optional. The categories associated with a category page. + // Must be set for category navigation queries to achieve good search quality. + // The format should be the same as UserEvent.PageInfo.page_category. This + // field is the equivalent of the query for browse (navigation) queries. It's + // used by the browse model when the query is empty. If the field is empty, it + // will not be used by the browse model. To represent full path of a category, + // use '>' character to separate different hierarchies. If '>' is part of the + // category name, replace it with other character(s). For example, `Graphics + // Cards > RTX>4090 > Founders Edition` where "RTX > 4090" represents one + // level, can be rewritten as `Graphics Cards > RTX_4090 > Founders Edition` + PageCategories []string `json:"pageCategories,omitempty"` // PageSize: Maximum number of Documents to return. The maximum allowed value // depends on the data type. Values above the maximum value are coerced to the // maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * @@ -13280,6 +12857,48 @@ func (s GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpecMod return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec: Specification for +// crowding. Crowding improves the diversity of search results by limiting the +// number of results that share the same field value. For example, crowding on +// the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will +// return at most 3 results with the same color across all pages. +type GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec struct { + // Field: The field to use for crowding. Documents can be crowded by a field in + // the Document object. Crowding field is case sensitive. + Field string `json:"field,omitempty"` + // MaxCount: The maximum number of documents to keep per value of the field. + // Once there are at least max_count previous results which contain the same + // value for the given field (according to the order specified in `order_by`), + // later results with the same value are "crowded away". If not specified, the + // default value is 1. + MaxCount int64 `json:"maxCount,omitempty"` + // Mode: Mode to use for documents that are crowded away. + // + // Possible values: + // "MODE_UNSPECIFIED" - Unspecified crowding mode. In this case, server + // behavior defaults to Mode.DROP_CROWDED_RESULTS. + // "DROP_CROWDED_RESULTS" - Drop crowded results. + // "DEMOTE_CROWDED_RESULTS_TO_END" - Demote crowded results to the later + // pages. + Mode string `json:"mode,omitempty"` + // ForceSendFields is a list of field names (e.g. "Field") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Field") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1SearchRequestCrowdingSpec + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec: A struct to define // data stores to filter on in a search call and configurations for those data // stores. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -14978,6 +14597,8 @@ type GoogleCloudDiscoveryengineV1StreamAssistResponse struct { // AssistToken: A global unique ID that identifies the current pair of request // and stream of responses. Used for feedback and support. AssistToken string `json:"assistToken,omitempty"` + // InvocationTools: The tool names of the tools that were invoked. + InvocationTools []string `json:"invocationTools,omitempty"` // SessionInfo: Session information. Only included in the final // StreamAssistResponse of the response stream. SessionInfo *GoogleCloudDiscoveryengineV1StreamAssistResponseSessionInfo `json:"sessionInfo,omitempty"` @@ -23210,6 +22831,15 @@ type GoogleCloudDiscoveryengineV1alphaSearchRequest struct { // ContentSearchSpec: A specification for configuring the behavior of content // search. ContentSearchSpec *GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec `json:"contentSearchSpec,omitempty"` + // CrowdingSpecs: Optional. Crowding specifications for improving result + // diversity. If multiple CrowdingSpecs are specified, crowding will be + // evaluated on each unique combination of the `field` values, and max_count + // will be the maximum value of `max_count` across all CrowdingSpecs. For + // example, if the first CrowdingSpec has `field` = "color" and `max_count` = + // 3, and the second CrowdingSpec has `field` = "size" and `max_count` = 2, + // then after 3 documents that share the same color AND size have been + // returned, subsequent ones should be removed or demoted. + CrowdingSpecs []*GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec `json:"crowdingSpecs,omitempty"` // CustomFineTuningSpec: Custom fine tuning configs. If set, it has higher // priority than the configs set in ServingConfig.custom_fine_tuning_spec. CustomFineTuningSpec *GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec `json:"customFineTuningSpec,omitempty"` @@ -23279,6 +22909,17 @@ type GoogleCloudDiscoveryengineV1alphaSearchRequest struct { // (https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). // If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. OrderBy string `json:"orderBy,omitempty"` + // PageCategories: Optional. The categories associated with a category page. + // Must be set for category navigation queries to achieve good search quality. + // The format should be the same as UserEvent.PageInfo.page_category. This + // field is the equivalent of the query for browse (navigation) queries. It's + // used by the browse model when the query is empty. If the field is empty, it + // will not be used by the browse model. To represent full path of a category, + // use '>' character to separate different hierarchies. If '>' is part of the + // category name, replace it with other character(s). For example, `Graphics + // Cards > RTX>4090 > Founders Edition` where "RTX > 4090" represents one + // level, can be rewritten as `Graphics Cards > RTX_4090 > Founders Edition` + PageCategories []string `json:"pageCategories,omitempty"` // PageSize: Maximum number of Documents to return. The maximum allowed value // depends on the data type. Values above the maximum value are coerced to the // maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * @@ -24015,6 +23656,48 @@ func (s GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySp return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec: Specification +// for crowding. Crowding improves the diversity of search results by limiting +// the number of results that share the same field value. For example, crowding +// on the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will +// return at most 3 results with the same color across all pages. +type GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec struct { + // Field: The field to use for crowding. Documents can be crowded by a field in + // the Document object. Crowding field is case sensitive. + Field string `json:"field,omitempty"` + // MaxCount: The maximum number of documents to keep per value of the field. + // Once there are at least max_count previous results which contain the same + // value for the given field (according to the order specified in `order_by`), + // later results with the same value are "crowded away". If not specified, the + // default value is 1. + MaxCount int64 `json:"maxCount,omitempty"` + // Mode: Mode to use for documents that are crowded away. + // + // Possible values: + // "MODE_UNSPECIFIED" - Unspecified crowding mode. In this case, server + // behavior defaults to Mode.DROP_CROWDED_RESULTS. + // "DROP_CROWDED_RESULTS" - Drop crowded results. + // "DEMOTE_CROWDED_RESULTS_TO_END" - Demote crowded results to the later + // pages. + Mode string `json:"mode,omitempty"` + // ForceSendFields is a list of field names (e.g. "Field") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Field") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec: A struct to // define data stores to filter on in a search call and configurations for // those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -28756,6 +28439,15 @@ type GoogleCloudDiscoveryengineV1betaSearchRequest struct { // ContentSearchSpec: A specification for configuring the behavior of content // search. ContentSearchSpec *GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec `json:"contentSearchSpec,omitempty"` + // CrowdingSpecs: Optional. Crowding specifications for improving result + // diversity. If multiple CrowdingSpecs are specified, crowding will be + // evaluated on each unique combination of the `field` values, and max_count + // will be the maximum value of `max_count` across all CrowdingSpecs. For + // example, if the first CrowdingSpec has `field` = "color" and `max_count` = + // 3, and the second CrowdingSpec has `field` = "size" and `max_count` = 2, + // then after 3 documents that share the same color AND size have been + // returned, subsequent ones should be removed or demoted. + CrowdingSpecs []*GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec `json:"crowdingSpecs,omitempty"` // DataStoreSpecs: Specifications that define the specific DataStores to be // searched, along with configurations for those data stores. This is only // considered for Engines with multiple data stores. For engines with a single @@ -28822,6 +28514,17 @@ type GoogleCloudDiscoveryengineV1betaSearchRequest struct { // (https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). // If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. OrderBy string `json:"orderBy,omitempty"` + // PageCategories: Optional. The categories associated with a category page. + // Must be set for category navigation queries to achieve good search quality. + // The format should be the same as UserEvent.PageInfo.page_category. This + // field is the equivalent of the query for browse (navigation) queries. It's + // used by the browse model when the query is empty. If the field is empty, it + // will not be used by the browse model. To represent full path of a category, + // use '>' character to separate different hierarchies. If '>' is part of the + // category name, replace it with other character(s). For example, `Graphics + // Cards > RTX>4090 > Founders Edition` where "RTX > 4090" represents one + // level, can be rewritten as `Graphics Cards > RTX_4090 > Founders Edition` + PageCategories []string `json:"pageCategories,omitempty"` // PageSize: Maximum number of Documents to return. The maximum allowed value // depends on the data type. Values above the maximum value are coerced to the // maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * @@ -29553,6 +29256,48 @@ func (s GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpe return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec: Specification for +// crowding. Crowding improves the diversity of search results by limiting the +// number of results that share the same field value. For example, crowding on +// the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will +// return at most 3 results with the same color across all pages. +type GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec struct { + // Field: The field to use for crowding. Documents can be crowded by a field in + // the Document object. Crowding field is case sensitive. + Field string `json:"field,omitempty"` + // MaxCount: The maximum number of documents to keep per value of the field. + // Once there are at least max_count previous results which contain the same + // value for the given field (according to the order specified in `order_by`), + // later results with the same value are "crowded away". If not specified, the + // default value is 1. + MaxCount int64 `json:"maxCount,omitempty"` + // Mode: Mode to use for documents that are crowded away. + // + // Possible values: + // "MODE_UNSPECIFIED" - Unspecified crowding mode. In this case, server + // behavior defaults to Mode.DROP_CROWDED_RESULTS. + // "DROP_CROWDED_RESULTS" - Drop crowded results. + // "DEMOTE_CROWDED_RESULTS_TO_END" - Demote crowded results to the later + // pages. + Mode string `json:"mode,omitempty"` + // ForceSendFields is a list of field names (e.g. "Field") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Field") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec: A struct to // define data stores to filter on in a search call and configurations for // those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -30747,8 +30492,8 @@ type GoogleLongrunningListOperationsResponse struct { Operations []*GoogleLongrunningOperation `json:"operations,omitempty"` // Unreachable: Unordered list. Unreachable resources. Populated when the // request sets `ListOperationsRequest.return_partial_success` and reads across - // collections e.g. when attempting to list all resources across all supported - // locations. + // collections. For example, when attempting to list all resources across all + // supported locations. Unreachable []string `json:"unreachable,omitempty"` // ServerResponse contains the HTTP response code and headers from the server. @@ -31181,147 +30926,6 @@ func (s GoogleTypeTimeZone) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -type MediaDownloadCall struct { - s *Service - name string - urlParams_ gensupport.URLParams - ifNoneMatch_ string - ctx_ context.Context - header_ http.Header -} - -// Download: Downloads a file from the session. -// -// - name: The resource name of the Session. Format: -// `projects/{project}/locations/{location}/collections/{collection}/engines/{ -// engine}/sessions/{session}`. -func (r *MediaService) Download(name string) *MediaDownloadCall { - c := &MediaDownloadCall{s: r.s, urlParams_: make(gensupport.URLParams)} - c.name = name - return c -} - -// FileId sets the optional parameter "fileId": Required. The ID of the file to -// be downloaded. -func (c *MediaDownloadCall) FileId(fileId string) *MediaDownloadCall { - c.urlParams_.Set("fileId", fileId) - return c -} - -// ViewId sets the optional parameter "viewId": The ID of the view to be -// downloaded. -func (c *MediaDownloadCall) ViewId(viewId string) *MediaDownloadCall { - c.urlParams_.Set("viewId", viewId) - return c -} - -// Fields allows partial responses to be retrieved. See -// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more -// details. -func (c *MediaDownloadCall) Fields(s ...googleapi.Field) *MediaDownloadCall { - c.urlParams_.Set("fields", googleapi.CombineFields(s)) - return c -} - -// IfNoneMatch sets an optional parameter which makes the operation fail if the -// object's ETag matches the given value. This is useful for getting updates -// only after the object has changed since the last request. -func (c *MediaDownloadCall) IfNoneMatch(entityTag string) *MediaDownloadCall { - c.ifNoneMatch_ = entityTag - return c -} - -// Context sets the context to be used in this call's Do and Download methods. -func (c *MediaDownloadCall) Context(ctx context.Context) *MediaDownloadCall { - c.ctx_ = ctx - return c -} - -// Header returns a http.Header that can be modified by the caller to add -// headers to the request. -func (c *MediaDownloadCall) Header() http.Header { - if c.header_ == nil { - c.header_ = make(http.Header) - } - return c.header_ -} - -func (c *MediaDownloadCall) doRequest(alt string) (*http.Response, error) { - reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_) - if c.ifNoneMatch_ != "" { - reqHeaders.Set("If-None-Match", c.ifNoneMatch_) - } - c.urlParams_.Set("alt", alt) - c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}:downloadFile") - urls += "?" + c.urlParams_.Encode() - req, err := http.NewRequest("GET", urls, nil) - if err != nil { - return nil, err - } - req.Header = reqHeaders - googleapi.Expand(req.URL, map[string]string{ - "name": c.name, - }) - c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "discoveryengine.media.download", "request", internallog.HTTPRequest(req, nil)) - return gensupport.SendRequest(c.ctx_, c.s.client, req) -} - -// Download fetches the API endpoint's "media" value, instead of the normal -// API response value. If the returned error is nil, the Response is guaranteed to -// have a 2xx status code. Callers must close the Response.Body as usual. -func (c *MediaDownloadCall) Download(opts ...googleapi.CallOption) (*http.Response, error) { - gensupport.SetOptions(c.urlParams_, opts...) - res, err := c.doRequest("media") - if err != nil { - return nil, err - } - if err := googleapi.CheckResponse(res); err != nil { - res.Body.Close() - return nil, gensupport.WrapError(err) - } - return res, nil -} - -// Do executes the "discoveryengine.media.download" call. -// Any non-2xx status code is an error. Response headers are in either -// *GdataMedia.ServerResponse.Header or (if a response was returned at all) in -// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check -// whether the returned error was because http.StatusNotModified was returned. -func (c *MediaDownloadCall) Do(opts ...googleapi.CallOption) (*GdataMedia, error) { - gensupport.SetOptions(c.urlParams_, opts...) - res, err := c.doRequest("json") - if res != nil && res.StatusCode == http.StatusNotModified { - if res.Body != nil { - res.Body.Close() - } - return nil, gensupport.WrapError(&googleapi.Error{ - Code: res.StatusCode, - Header: res.Header, - }) - } - if err != nil { - return nil, err - } - defer googleapi.CloseBody(res) - if err := googleapi.CheckResponse(res); err != nil { - return nil, gensupport.WrapError(err) - } - ret := &GdataMedia{ - ServerResponse: googleapi.ServerResponse{ - Header: res.Header, - HTTPStatusCode: res.StatusCode, - }, - } - target := &ret - b, err := gensupport.DecodeResponseBytes(target, res) - if err != nil { - return nil, err - } - c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "discoveryengine.media.download", "response", internallog.HTTPResponse(res, b)) - return ret, nil -} - type ProjectsProvisionCall struct { s *Service name string @@ -33047,9 +32651,9 @@ func (c *ProjectsLocationsCollectionsDataConnectorOperationsListCall) PageToken( // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsCollectionsDataConnectorOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsCollectionsDataConnectorOperationsListCall { @@ -35432,9 +35036,9 @@ func (c *ProjectsLocationsCollectionsDataStoresBranchesOperationsListCall) PageT // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsCollectionsDataStoresBranchesOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsCollectionsDataStoresBranchesOperationsListCall { @@ -37460,9 +37064,9 @@ func (c *ProjectsLocationsCollectionsDataStoresModelsOperationsListCall) PageTok // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsCollectionsDataStoresModelsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsCollectionsDataStoresModelsOperationsListCall { @@ -37737,9 +37341,9 @@ func (c *ProjectsLocationsCollectionsDataStoresOperationsListCall) PageToken(pag // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsCollectionsDataStoresOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsCollectionsDataStoresOperationsListCall { @@ -38607,9 +38211,9 @@ func (c *ProjectsLocationsCollectionsDataStoresSchemasOperationsListCall) PageTo // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsCollectionsDataStoresSchemasOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsCollectionsDataStoresSchemasOperationsListCall { @@ -41170,9 +40774,9 @@ func (c *ProjectsLocationsCollectionsDataStoresSiteSearchEngineOperationsListCal // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsCollectionsDataStoresSiteSearchEngineOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsCollectionsDataStoresSiteSearchEngineOperationsListCall { @@ -42465,9 +42069,9 @@ func (c *ProjectsLocationsCollectionsDataStoresSiteSearchEngineTargetSitesOperat // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsCollectionsDataStoresSiteSearchEngineTargetSitesOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsCollectionsDataStoresSiteSearchEngineTargetSitesOperationsListCall { @@ -44125,6 +43729,224 @@ func (c *ProjectsLocationsCollectionsEnginesPatchCall) Do(opts ...googleapi.Call return ret, nil } +type ProjectsLocationsCollectionsEnginesAssistantsCreateCall struct { + s *Service + parent string + googleclouddiscoveryenginev1assistant *GoogleCloudDiscoveryengineV1Assistant + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// Create: Creates an Assistant. +// +// - parent: The parent resource name. Format: +// `projects/{project}/locations/{location}/collections/{collection}/engines/{ +// engine}`. +func (r *ProjectsLocationsCollectionsEnginesAssistantsService) Create(parent string, googleclouddiscoveryenginev1assistant *GoogleCloudDiscoveryengineV1Assistant) *ProjectsLocationsCollectionsEnginesAssistantsCreateCall { + c := &ProjectsLocationsCollectionsEnginesAssistantsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.parent = parent + c.googleclouddiscoveryenginev1assistant = googleclouddiscoveryenginev1assistant + return c +} + +// AssistantId sets the optional parameter "assistantId": Required. The ID to +// use for the Assistant, which will become the final component of the +// Assistant's resource name. This field must conform to RFC-1034 +// (https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters. +func (c *ProjectsLocationsCollectionsEnginesAssistantsCreateCall) AssistantId(assistantId string) *ProjectsLocationsCollectionsEnginesAssistantsCreateCall { + c.urlParams_.Set("assistantId", assistantId) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more +// details. +func (c *ProjectsLocationsCollectionsEnginesAssistantsCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsCollectionsEnginesAssistantsCreateCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. +func (c *ProjectsLocationsCollectionsEnginesAssistantsCreateCall) Context(ctx context.Context) *ProjectsLocationsCollectionsEnginesAssistantsCreateCall { + c.ctx_ = ctx + return c +} + +// Header returns a http.Header that can be modified by the caller to add +// headers to the request. +func (c *ProjectsLocationsCollectionsEnginesAssistantsCreateCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsCollectionsEnginesAssistantsCreateCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "application/json", c.header_) + body, err := googleapi.WithoutDataWrapper.JSONBuffer(c.googleclouddiscoveryenginev1assistant) + if err != nil { + return nil, err + } + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+parent}/assistants") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "parent": c.parent, + }) + c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.collections.engines.assistants.create", "request", internallog.HTTPRequest(req, body.Bytes())) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "discoveryengine.projects.locations.collections.engines.assistants.create" call. +// Any non-2xx status code is an error. Response headers are in either +// *GoogleCloudDiscoveryengineV1Assistant.ServerResponse.Header or (if a +// response was returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsLocationsCollectionsEnginesAssistantsCreateCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDiscoveryengineV1Assistant, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleCloudDiscoveryengineV1Assistant{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + b, err := gensupport.DecodeResponseBytes(target, res) + if err != nil { + return nil, err + } + c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.collections.engines.assistants.create", "response", internallog.HTTPResponse(res, b)) + return ret, nil +} + +type ProjectsLocationsCollectionsEnginesAssistantsDeleteCall struct { + s *Service + name string + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// Delete: Deletes an Assistant. +// +// - name: Resource name of Assistant. Format: +// `projects/{project}/locations/{location}/collections/{collection}/engines/{ +// engine}/assistants/{assistant}` If the caller does not have permission to +// delete the Assistant, regardless of whether or not it exists, a +// PERMISSION_DENIED error is returned. If the Assistant to delete does not +// exist, a NOT_FOUND error is returned. +func (r *ProjectsLocationsCollectionsEnginesAssistantsService) Delete(name string) *ProjectsLocationsCollectionsEnginesAssistantsDeleteCall { + c := &ProjectsLocationsCollectionsEnginesAssistantsDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more +// details. +func (c *ProjectsLocationsCollectionsEnginesAssistantsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsCollectionsEnginesAssistantsDeleteCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. +func (c *ProjectsLocationsCollectionsEnginesAssistantsDeleteCall) Context(ctx context.Context) *ProjectsLocationsCollectionsEnginesAssistantsDeleteCall { + c.ctx_ = ctx + return c +} + +// Header returns a http.Header that can be modified by the caller to add +// headers to the request. +func (c *ProjectsLocationsCollectionsEnginesAssistantsDeleteCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsCollectionsEnginesAssistantsDeleteCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_) + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("DELETE", urls, nil) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.collections.engines.assistants.delete", "request", internallog.HTTPRequest(req, nil)) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "discoveryengine.projects.locations.collections.engines.assistants.delete" call. +// Any non-2xx status code is an error. Response headers are in either +// *GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned at +// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to +// check whether the returned error was because http.StatusNotModified was +// returned. +func (c *ProjectsLocationsCollectionsEnginesAssistantsDeleteCall) Do(opts ...googleapi.CallOption) (*GoogleProtobufEmpty, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleProtobufEmpty{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + b, err := gensupport.DecodeResponseBytes(target, res) + if err != nil { + return nil, err + } + c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.collections.engines.assistants.delete", "response", internallog.HTTPResponse(res, b)) + return ret, nil +} + type ProjectsLocationsCollectionsEnginesAssistantsGetCall struct { s *Service name string @@ -44237,6 +44059,157 @@ func (c *ProjectsLocationsCollectionsEnginesAssistantsGetCall) Do(opts ...google return ret, nil } +type ProjectsLocationsCollectionsEnginesAssistantsListCall struct { + s *Service + parent string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// List: Lists all Assistants under an Engine. +// +// - parent: The parent resource name. Format: +// `projects/{project}/locations/{location}/collections/{collection}/engines/{ +// engine}`. +func (r *ProjectsLocationsCollectionsEnginesAssistantsService) List(parent string) *ProjectsLocationsCollectionsEnginesAssistantsListCall { + c := &ProjectsLocationsCollectionsEnginesAssistantsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.parent = parent + return c +} + +// PageSize sets the optional parameter "pageSize": Maximum number of +// Assistants to return. If unspecified, defaults to 100. The maximum allowed +// value is 1000; anything above that will be coerced down to 1000. +func (c *ProjectsLocationsCollectionsEnginesAssistantsListCall) PageSize(pageSize int64) *ProjectsLocationsCollectionsEnginesAssistantsListCall { + c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) + return c +} + +// PageToken sets the optional parameter "pageToken": A page token +// ListAssistantsResponse.next_page_token, received from a previous +// AssistantService.ListAssistants call. Provide this to retrieve the +// subsequent page. When paginating, all other parameters provided to +// ListAssistants must match the call that provided the page token. +func (c *ProjectsLocationsCollectionsEnginesAssistantsListCall) PageToken(pageToken string) *ProjectsLocationsCollectionsEnginesAssistantsListCall { + c.urlParams_.Set("pageToken", pageToken) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more +// details. +func (c *ProjectsLocationsCollectionsEnginesAssistantsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsCollectionsEnginesAssistantsListCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets an optional parameter which makes the operation fail if the +// object's ETag matches the given value. This is useful for getting updates +// only after the object has changed since the last request. +func (c *ProjectsLocationsCollectionsEnginesAssistantsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsCollectionsEnginesAssistantsListCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. +func (c *ProjectsLocationsCollectionsEnginesAssistantsListCall) Context(ctx context.Context) *ProjectsLocationsCollectionsEnginesAssistantsListCall { + c.ctx_ = ctx + return c +} + +// Header returns a http.Header that can be modified by the caller to add +// headers to the request. +func (c *ProjectsLocationsCollectionsEnginesAssistantsListCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsCollectionsEnginesAssistantsListCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+parent}/assistants") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, nil) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "parent": c.parent, + }) + c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.collections.engines.assistants.list", "request", internallog.HTTPRequest(req, nil)) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "discoveryengine.projects.locations.collections.engines.assistants.list" call. +// Any non-2xx status code is an error. Response headers are in either +// *GoogleCloudDiscoveryengineV1ListAssistantsResponse.ServerResponse.Header or +// (if a response was returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsLocationsCollectionsEnginesAssistantsListCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDiscoveryengineV1ListAssistantsResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleCloudDiscoveryengineV1ListAssistantsResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + b, err := gensupport.DecodeResponseBytes(target, res) + if err != nil { + return nil, err + } + c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.collections.engines.assistants.list", "response", internallog.HTTPResponse(res, b)) + return ret, nil +} + +// Pages invokes f for each page of results. +// A non-nil error returned from f will halt the iteration. +// The provided context supersedes any context provided to the Context method. +func (c *ProjectsLocationsCollectionsEnginesAssistantsListCall) Pages(ctx context.Context, f func(*GoogleCloudDiscoveryengineV1ListAssistantsResponse) error) error { + c.ctx_ = ctx + defer c.PageToken(c.urlParams_.Get("pageToken")) + for { + x, err := c.Do() + if err != nil { + return err + } + if err := f(x); err != nil { + return err + } + if x.NextPageToken == "" { + return nil + } + c.PageToken(x.NextPageToken) + } +} + type ProjectsLocationsCollectionsEnginesAssistantsPatchCall struct { s *Service name string @@ -44457,6 +44430,118 @@ func (c *ProjectsLocationsCollectionsEnginesAssistantsStreamAssistCall) Do(opts return ret, nil } +type ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall struct { + s *Service + name string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// 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. +// +// - name: The name of the operation resource. +func (r *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsService) Get(name string) *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall { + c := &ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more +// details. +func (c *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets an optional parameter which makes the operation fail if the +// object's ETag matches the given value. This is useful for getting updates +// only after the object has changed since the last request. +func (c *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. +func (c *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall { + c.ctx_ = ctx + return c +} + +// Header returns a http.Header that can be modified by the caller to add +// headers to the request. +func (c *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, nil) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.collections.engines.assistants.agents.operations.get", "request", internallog.HTTPRequest(req, nil)) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "discoveryengine.projects.locations.collections.engines.assistants.agents.operations.get" call. +// Any non-2xx status code is an error. Response headers are in either +// *GoogleLongrunningOperation.ServerResponse.Header or (if a response was +// returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleLongrunningOperation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + b, err := gensupport.DecodeResponseBytes(target, res) + if err != nil { + return nil, err + } + c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.collections.engines.assistants.agents.operations.get", "response", internallog.HTTPResponse(res, b)) + return ret, nil +} + type ProjectsLocationsCollectionsEnginesCompletionConfigCompleteQueryCall struct { s *Service completionConfig string @@ -46149,9 +46234,9 @@ func (c *ProjectsLocationsCollectionsEnginesOperationsListCall) PageToken(pageTo // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsCollectionsEnginesOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsCollectionsEnginesOperationsListCall { @@ -48378,9 +48463,9 @@ func (c *ProjectsLocationsCollectionsOperationsListCall) PageToken(pageToken str // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsCollectionsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsCollectionsOperationsListCall { @@ -50656,9 +50741,9 @@ func (c *ProjectsLocationsDataStoresBranchesOperationsListCall) PageToken(pageTo // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsDataStoresBranchesOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsDataStoresBranchesOperationsListCall { @@ -52571,9 +52656,9 @@ func (c *ProjectsLocationsDataStoresModelsOperationsListCall) PageToken(pageToke // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsDataStoresModelsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsDataStoresModelsOperationsListCall { @@ -52848,9 +52933,9 @@ func (c *ProjectsLocationsDataStoresOperationsListCall) PageToken(pageToken stri // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsDataStoresOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsDataStoresOperationsListCall { @@ -58661,9 +58746,9 @@ func (c *ProjectsLocationsIdentityMappingStoresOperationsListCall) PageToken(pag // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsIdentityMappingStoresOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsIdentityMappingStoresOperationsListCall { @@ -59280,9 +59365,9 @@ func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *Proje // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsOperationsListCall { @@ -60664,16 +60749,22 @@ func (r *ProjectsLocationsUserStoresUserLicensesService) List(parent string) *Pr return c } -// Filter sets the optional parameter "filter": Filter for the list request. -// Supported fields: * `license`_`assignment`_`state` * `user_principal` * -// `user_profile` Examples: * `license`_`assignment`_`state = ASSIGNED` to list -// assigned user licenses. * `license`_`assignment`_`state = NO_LICENSE` to -// list not licensed users. * `license`_`assignment`_`state = -// NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license -// assigned. * `license`_`assignment`_`state != NO_LICENSE_ATTEMPTED_LOGIN` to -// filter out users who attempted login but no license assigned. -func (c *ProjectsLocationsUserStoresUserLicensesListCall) Filter(filter string) *ProjectsLocationsUserStoresUserLicensesListCall { - c.urlParams_.Set("filter", filter) +// OrderBy sets the optional parameter "orderBy": The order in which the +// UserLicenses are listed. The value must be a comma-separated list of fields. +// Default sorting order is ascending. To specify descending order for a field, +// append a " desc" suffix. Redundant space characters in the syntax are +// insignificant. Supported fields: * `license_assignment_state` * +// `user_principal` * `user_profile` * `last_login_date` * `update_time` If not +// set, the default ordering is by `user_principal`. Examples: * +// `user_principal desc` to order by `user_principal` in descending order. * +// `license_assignment_state` to order by `license_assignment_state` in +// ascending order. * `last_login_date desc` to order by `last_login_date` in +// descending order. * `update_time desc` to order by `update_time` in +// descending order. * `last_login_date desc, user_principal` to order by +// `last_login_date` in descending order and then by `user_principal` in +// ascending order. +func (c *ProjectsLocationsUserStoresUserLicensesListCall) OrderBy(orderBy string) *ProjectsLocationsUserStoresUserLicensesListCall { + c.urlParams_.Set("orderBy", orderBy) return c } @@ -61074,9 +61165,9 @@ func (c *ProjectsOperationsListCall) PageToken(pageToken string) *ProjectsOperat // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsOperationsListCall { diff --git a/discoveryengine/v1alpha/discoveryengine-api.json b/discoveryengine/v1alpha/discoveryengine-api.json index 861dd0e9cf2..ff8cfa6105e 100644 --- a/discoveryengine/v1alpha/discoveryengine-api.json +++ b/discoveryengine/v1alpha/discoveryengine-api.json @@ -270,91 +270,6 @@ } } }, - "media": { - "methods": { - "download": { - "description": "Downloads a file from the session.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}:downloadFile", - "httpMethod": "GET", - "id": "discoveryengine.media.download", - "parameterOrder": [ - "name" - ], - "parameters": { - "fileId": { - "description": "Required. The ID of the file to be downloaded.", - "location": "query", - "type": "string" - }, - "name": { - "description": "Required. The resource name of the Session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", - "required": true, - "type": "string" - }, - "viewId": { - "description": "Optional. The ID of the view to be downloaded.", - "location": "query", - "type": "string" - } - }, - "path": "v1alpha/{+name}:downloadFile", - "response": { - "$ref": "GdataMedia" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", - "https://www.googleapis.com/auth/discoveryengine.readwrite" - ], - "supportsMediaDownload": true, - "useMediaDownloadService": true - }, - "upload": { - "description": "Uploads a file for the assistant to use as a source of information within the session.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}:uploadFile", - "httpMethod": "POST", - "id": "discoveryengine.media.upload", - "mediaUpload": { - "accept": [ - "*/*" - ], - "protocols": { - "simple": { - "multipart": true, - "path": "/upload/v1alpha/{+name}:uploadFile" - } - } - }, - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the Session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+name}:uploadFile", - "request": { - "$ref": "GoogleCloudDiscoveryengineV1alphaUploadSessionFileRequest" - }, - "response": { - "$ref": "GoogleCloudDiscoveryengineV1alphaUploadSessionFileResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", - "https://www.googleapis.com/auth/discoveryengine.readwrite" - ], - "supportsMediaUpload": true - } - } - }, "projects": { "methods": { "get": { @@ -561,15 +476,51 @@ "https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, - "getConfigurablePricingUsageStats": { - "description": "Gets configurable pricing usage stats.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/configurablePricingUsageStats", + "obtainCrawlRate": { + "description": "Obtains the time series data of organic or dedicated crawl rate for monitoring. When dedicated crawl rate is not set, it will return vertex AI's organic crawl rate time series. Organic crawl means Google automatically crawl the internet at its own convenience. When dedicated crawl rate is set, it will return vertex AI's dedicated crawl rate time series.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}:obtainCrawlRate", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.obtainCrawlRate", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "description": "Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+location}:obtainCrawlRate", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaObtainCrawlRateRequest" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, + "queryConfigurablePricingUsageStats": { + "description": "Queries configurable pricing usage stats for a project.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{location}:queryConfigurablePricingUsageStats", "httpMethod": "GET", - "id": "discoveryengine.projects.locations.getConfigurablePricingUsageStats", + "id": "discoveryengine.projects.locations.queryConfigurablePricingUsageStats", "parameterOrder": [ - "name" + "project", + "location" ], "parameters": { + "location": { + "description": "Required. The location to query usage stats for.", + "location": "path", + "required": true, + "type": "string" + }, "metricTypes": { "description": "Optional. The metric types to return usage for.", "enum": [ @@ -592,10 +543,10 @@ "repeated": true, "type": "string" }, - "name": { - "description": "Required. The name of the ConfigurablePricingUsageStats to retrieve. Format: projects/{project}/locations/{location}/configurablePricingUsageStats", + "project": { + "description": "Required. The project to query usage stats for. Format: projects/{project}", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/configurablePricingUsageStats$", + "pattern": "^projects/[^/]+$", "required": true, "type": "string" }, @@ -636,38 +587,9 @@ "type": "integer" } }, - "path": "v1alpha/{+name}", + "path": "v1alpha/{+project}/locations/{location}:queryConfigurablePricingUsageStats", "response": { - "$ref": "GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStats" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/discoveryengine.readwrite" - ] - }, - "obtainCrawlRate": { - "description": "Obtains the time series data of organic or dedicated crawl rate for monitoring. When dedicated crawl rate is not set, it will return vertex AI's organic crawl rate time series. Organic crawl means Google automatically crawl the internet at its own convenience. When dedicated crawl rate is set, it will return vertex AI's dedicated crawl rate time series.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}:obtainCrawlRate", - "httpMethod": "POST", - "id": "discoveryengine.projects.locations.obtainCrawlRate", - "parameterOrder": [ - "location" - ], - "parameters": { - "location": { - "description": "Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+location}:obtainCrawlRate", - "request": { - "$ref": "GoogleCloudDiscoveryengineV1alphaObtainCrawlRateRequest" - }, - "response": { - "$ref": "GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse" + "$ref": "GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -1563,7 +1485,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -2502,7 +2424,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -3075,7 +2997,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -3154,7 +3076,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -3392,7 +3314,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -4141,7 +4063,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -4489,7 +4411,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -5109,6 +5031,68 @@ }, "assistants": { "methods": { + "create": { + "description": "Creates an Assistant.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.collections.engines.assistants.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "assistantId": { + "description": "Required. The ID to use for the Assistant, which will become the final component of the Assistant's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/assistants", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAssistant" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAssistant" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, + "delete": { + "description": "Deletes an Assistant.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}", + "httpMethod": "DELETE", + "id": "discoveryengine.projects.locations.collections.engines.assistants.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` If the caller does not have permission to delete the Assistant, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Assistant to delete does not exist, a NOT_FOUND error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, "get": { "description": "Gets an Assistant.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}", @@ -5136,6 +5120,44 @@ "https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, + "list": { + "description": "Lists all Assistants under an Engine.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.engines.assistants.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of Assistants to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token ListAssistantsResponse.next_page_token, received from a previous AssistantService.ListAssistants call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAssistants must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/assistants", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaListAssistantsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, "listAvailableAgentViews": { "description": "Lists the data for displaying the Agents under an Assistant which are available to the caller.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}:listAvailableAgentViews", @@ -5667,6 +5689,36 @@ ] } } + }, + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.engines.assistants.agents.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + } + } } } }, @@ -6333,7 +6385,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -6999,7 +7051,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -7909,7 +7961,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -8452,7 +8504,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -8531,7 +8583,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -10306,7 +10358,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -10721,42 +10773,6 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/discoveryengine.readwrite" ] - }, - "uploadFile": { - "description": "Uploads a file for Notebook LM to use. Creates a Source.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/notebooks/{notebooksId}/sources/{sourceId}:uploadFile", - "httpMethod": "POST", - "id": "discoveryengine.projects.locations.notebooks.sources.uploadFile", - "parameterOrder": [ - "parent", - "sourceId" - ], - "parameters": { - "parent": { - "description": "Required. The parent resource where the sources will be created. Format: projects/{project}/locations/{location}/notebooks/{notebook}", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebooks/[^/]+$", - "required": true, - "type": "string" - }, - "sourceId": { - "description": "The source id of the associated file. If not set, a source id will be generated and a new tentative source will be created.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+parent}/sources/{sourceId}:uploadFile", - "request": { - "$ref": "GoogleCloudNotebooklmV1alphaUploadSourceFileRequest" - }, - "response": { - "$ref": "GoogleCloudNotebooklmV1alphaUploadSourceFileResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/discoveryengine.readwrite" - ] } } } @@ -10823,7 +10839,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -11681,7 +11697,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -11708,8 +11724,8 @@ "parent" ], "parameters": { - "filter": { - "description": "Optional. Filter for the list request. Supported fields: * `license`_`assignment`_`state` * `user_principal` * `user_profile` Examples: * `license`_`assignment`_`state = ASSIGNED` to list assigned user licenses. * `license`_`assignment`_`state = NO_LICENSE` to list not licensed users. * `license`_`assignment`_`state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license`_`assignment`_`state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned.", + "orderBy": { + "description": "Optional. The order in which the UserLicenses are listed. The value must be a comma-separated list of fields. Default sorting order is ascending. To specify descending order for a field, append a \" desc\" suffix. Redundant space characters in the syntax are insignificant. Supported fields: * `license_assignment_state` * `user_principal` * `user_profile` * `last_login_date` * `update_time` If not set, the default ordering is by `user_principal`. Examples: * `user_principal desc` to order by `user_principal` in descending order. * `license_assignment_state` to order by `license_assignment_state` in ascending order. * `last_login_date desc` to order by `last_login_date` in descending order. * `update_time desc` to order by `update_time` in descending order. * `last_login_date desc, user_principal` to order by `last_login_date` in descending order and then by `user_principal` in ascending order.", "location": "query", "type": "string" }, @@ -11808,7 +11824,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -11827,606 +11843,9 @@ } } }, - "revision": "20251109", + "revision": "20251116", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { - "ApiservingMediaRequestInfo": { - "description": "Extra information added to operations that support Scotty media requests.", - "id": "ApiservingMediaRequestInfo", - "properties": { - "currentBytes": { - "description": "The number of current bytes uploaded or downloaded.", - "format": "int64", - "type": "string" - }, - "customData": { - "description": "Data to be copied to backend requests. Custom data is returned to Scotty in the agent_state field, which Scotty will then provide in subsequent upload notifications.", - "type": "string" - }, - "diffObjectVersion": { - "description": "Set if the http request info is diff encoded. The value of this field is the version number of the base revision. This is corresponding to Apiary's mediaDiffObjectVersion (//depot/google3/java/com/google/api/server/media/variable/DiffObjectVersionVariable.java). See go/esf-scotty-diff-upload for more information.", - "type": "string" - }, - "finalStatus": { - "description": "The existence of the final_status field indicates that this is the last call to the agent for this request_id. http://google3/uploader/agent/scotty_agent.proto?l=737\u0026rcl=347601929", - "format": "int32", - "type": "integer" - }, - "notificationType": { - "description": "The type of notification received from Scotty.", - "enum": [ - "START", - "PROGRESS", - "END", - "RESPONSE_SENT", - "ERROR" - ], - "enumDescriptions": [ - "Such requests signals the start of a request containing media upload. Only the media field(s) in the inserted/updated resource are set. The response should either return an error or succeed. On success, responses don't need to contain anything.", - "Such requests signals that the upload has progressed and that the backend might want to access the media file specified in relevant fields in the resource. Only the media field(s) in the inserted/updated resource are set. The response should either return an error or succeed. On success, responses don't need to contain anything.", - "Such requests signals the end of a request containing media upload. END should be handled just like normal Insert/Upload requests, that is, they should process the request and return a complete resource in the response. Pointers to media data (a GFS path usually) appear in the relevant fields in the inserted/updated resource. See gdata.Media in data.proto.", - "Such requests occur after an END and signal that the response has been sent back to the client. RESPONSE_SENT is only sent to the backend if it is configured to receive them. The response does not need to contain anything.", - "Such requests indicate that an error occurred while processing the request. ERROR is only sent to the backend if it is configured to receive them. It is not guaranteed that all errors will result in this notification to the backend, even if the backend requests them. Since these requests are just for informational purposes, the response does not need to contain anything." - ], - "type": "string" - }, - "physicalHeaders": { - "description": "The physical headers provided by RequestReceivedParameters in Scotty request. type is uploader_service.KeyValuePairs.", - "format": "byte", - "type": "string" - }, - "requestId": { - "description": "The Scotty request ID.", - "type": "string" - }, - "requestReceivedParamsServingInfo": { - "description": "The partition of the Scotty server handling this request. type is uploader_service.RequestReceivedParamsServingInfo LINT.IfChange(request_received_params_serving_info_annotations) LINT.ThenChange()", - "format": "byte", - "type": "string" - }, - "totalBytes": { - "description": "The total size of the file.", - "format": "int64", - "type": "string" - }, - "totalBytesIsEstimated": { - "description": "Whether the total bytes field contains an estimated data.", - "type": "boolean" - } - }, - "type": "object" - }, - "ApiservingMediaResponseInfo": { - "description": "This message is for backends to pass their scotty media specific fields to ESF. Backend will include this in their response message to ESF. Example: ExportFile is an rpc defined for upload using scotty from ESF. rpc ExportFile(ExportFileRequest) returns (ExportFileResponse) Message ExportFileResponse will include apiserving.MediaResponseInfo to tell ESF about data like dynamic_dropzone it needs to pass to Scotty. message ExportFileResponse { optional gdata.Media blob = 1; optional apiserving.MediaResponseInfo media_response_info = 2 }", - "id": "ApiservingMediaResponseInfo", - "properties": { - "customData": { - "description": "Data to copy from backend response to the next backend requests. Custom data is returned to Scotty in the agent_state field, which Scotty will then provide in subsequent upload notifications.", - "type": "string" - }, - "dataStorageTransform": { - "description": "Specifies any transformation to be applied to data before persisting it or retrieving from storage. E.g., encryption options for blobstore2. This should be of the form uploader_service.DataStorageTransform.", - "format": "byte", - "type": "string" - }, - "destinationBlobMintIndex": { - "description": "For the first notification of a |diff_encoded| HttpRequestInfo, this is the index of the blob mint that Scotty should use when writing the resulting blob. This field is optional. It's not required ever, even if `original_object_blob_mint_index` is set. In situations like that, we will use the destination blob's mint for the destination blob and regular blob ACL checks for the original object. Note: This field is only for use by Drive API for diff uploads.", - "format": "int32", - "type": "integer" - }, - "dynamicDropTarget": { - "description": "Specifies the Scotty Drop Target to use for uploads. If present in a media response, Scotty does not upload to a standard drop zone. Instead, Scotty saves the upload directly to the location specified in this drop target. Unlike drop zones, the drop target is the final storage location for an upload. So, the agent does not need to clone the blob at the end of the upload. The agent is responsible for garbage collecting any orphaned blobs that may occur due to aborted uploads. For more information, see the drop target design doc here: http://goto/ScottyDropTarget This field will be preferred to dynamicDropzone. If provided, the identified field in the response must be of the type uploader.agent.DropTarget.", - "format": "byte", - "type": "string" - }, - "dynamicDropzone": { - "description": "Specifies the Scotty dropzone to use for uploads.", - "type": "string" - }, - "mediaForDiff": { - "$ref": "GdataMedia", - "description": "Diff Updates must respond to a START notification with this Media proto to tell Scotty to decode the diff encoded payload and apply the diff against this field. If the request was diff encoded, but this field is not set, Scotty will treat the encoding as identity. This is corresponding to Apiary's DiffUploadResponse.original_object (//depot/google3/gdata/rosy/proto/data.proto?l=413). See go/esf-scotty-diff-upload for more information." - }, - "originalObjectBlobMintIndex": { - "description": "For the first notification of a |diff_encoded| HttpRequestInfo, this is the index of the blob mint that Scotty should use when reading the original blob. This field is optional. It's not required ever, even if `destination_blob_mint_index` is set. In situations like that, we will use the destination blob's mint for the destination blob and regular blob ACL checks for the original object. Note: This field is only for use by Drive API for diff uploads.", - "format": "int32", - "type": "integer" - }, - "requestClass": { - "description": "Request class to use for all Blobstore operations for this request.", - "enum": [ - "UNKNOWN_REQUEST_CLASS", - "LATENCY_SENSITIVE", - "PRODUCTION_BATCH", - "BEST_EFFORT" - ], - "enumDescriptions": [ - "Unpopulated request_class in log files will be taken as 0 in dremel query. GoogleSQL will try to cast it to enum by default. An unused 0 value is added to avoid GoogleSQL casting error. Please refer to b/69677280.", - "A latency-sensitive request.", - "A request generated by a batch process.", - "A best-effort request." - ], - "type": "string" - }, - "scottyAgentUserId": { - "description": "Requester ID passed along to be recorded in the Scotty logs", - "format": "int64", - "type": "string" - }, - "scottyCustomerLog": { - "description": "Customer-specific data to be recorded in the Scotty logs type is logs_proto_scotty.CustomerLog", - "format": "byte", - "type": "string" - }, - "trafficClassField": { - "description": "Specifies the TrafficClass that Scotty should use for any RPCs to fetch the response bytes. Will override the traffic class GTOS of the incoming http request. This is a temporary field to facilitate whitelisting and experimentation by the bigstore agent only. For instance, this does not apply to RTMP reads. WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.", - "enum": [ - "BE1", - "AF1", - "AF2", - "AF3", - "AF4", - "NC1", - "NC0", - "BE0", - "LLQ", - "LLQ1", - "LLQ2", - "LLQ3" - ], - "enumDescriptions": [ - "Application-selectable traffic classes Best effort", - "Assured forwarding priority 1", - "Assured forwarding priority 2", - "Assured forwarding priority 3", - "Assured forwarding priority 4", - "Network control", - "Network control", - "Best effort at high packet loss", - "Low-latency queue (LLQ) best effort (go/llq)", - "LLQ assured forwarding priority 1 (go/llq2)", - "LLQ assured forwarding priority 2 (go/llq2)", - "LLQ assured forwarding priority 3 (go/llq3)" - ], - "type": "string" - }, - "verifyHashFromHeader": { - "description": "Tells Scotty to verify hashes on the agent's behalf by parsing out the X-Goog-Hash header.", - "type": "boolean" - } - }, - "type": "object" - }, - "GdataBlobstore2Info": { - "description": "Information to read/write to blobstore2.", - "id": "GdataBlobstore2Info", - "properties": { - "blobGeneration": { - "description": "The blob generation id.", - "format": "int64", - "type": "string" - }, - "blobId": { - "description": "The blob id, e.g., /blobstore/prod/playground/scotty", - "type": "string" - }, - "downloadReadHandle": { - "description": "Read handle passed from Bigstore -\u003e Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.", - "format": "byte", - "type": "string" - }, - "readToken": { - "description": "The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.", - "type": "string" - }, - "uploadMetadataContainer": { - "description": "Metadata passed from Blobstore -\u003e Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.", - "format": "byte", - "type": "string" - } - }, - "type": "object" - }, - "GdataCompositeMedia": { - "description": "A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites.", - "id": "GdataCompositeMedia", - "properties": { - "blobRef": { - "deprecated": true, - "description": "Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.", - "format": "byte", - "type": "string" - }, - "blobstore2Info": { - "$ref": "GdataBlobstore2Info", - "description": "Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob." - }, - "cosmoBinaryReference": { - "description": "A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.", - "format": "byte", - "type": "string" - }, - "crc32cHash": { - "description": "crc32.c hash for the payload.", - "format": "uint32", - "type": "integer" - }, - "inline": { - "description": "Media data, set if reference_type is INLINE", - "format": "byte", - "type": "string" - }, - "length": { - "description": "Size of the data, in bytes", - "format": "int64", - "type": "string" - }, - "md5Hash": { - "description": "MD5 hash for the payload.", - "format": "byte", - "type": "string" - }, - "objectId": { - "$ref": "GdataObjectId", - "description": "Reference to a TI Blob, set if reference_type is BIGSTORE_REF." - }, - "path": { - "description": "Path to the data, set if reference_type is PATH", - "type": "string" - }, - "referenceType": { - "description": "Describes what the field reference contains.", - "enum": [ - "PATH", - "BLOB_REF", - "INLINE", - "BIGSTORE_REF", - "COSMO_BINARY_REFERENCE" - ], - "enumDescriptions": [ - "Reference contains a GFS path or a local path.", - "Reference points to a blobstore object. This could be either a v1 blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info first, since v1 is being deprecated.", - "Data is included into this proto buffer", - "Reference points to a bigstore object", - "Indicates the data is stored in cosmo_binary_reference." - ], - "type": "string" - }, - "sha1Hash": { - "description": "SHA-1 hash for the payload.", - "format": "byte", - "type": "string" - } - }, - "type": "object" - }, - "GdataContentTypeInfo": { - "description": "Detailed Content-Type information from Scotty. The Content-Type of the media will typically be filled in by the header or Scotty's best_guess, but this extended information provides the backend with more information so that it can make a better decision if needed. This is only used on media upload requests from Scotty.", - "id": "GdataContentTypeInfo", - "properties": { - "bestGuess": { - "description": "Scotty's best guess of what the content type of the file is.", - "type": "string" - }, - "fromBytes": { - "description": "The content type of the file derived by looking at specific bytes (i.e. \"magic bytes\") of the actual file.", - "type": "string" - }, - "fromFileName": { - "description": "The content type of the file derived from the file extension of the original file name used by the client.", - "type": "string" - }, - "fromHeader": { - "description": "The content type of the file as specified in the request headers, multipart headers, or RUPIO start request.", - "type": "string" - }, - "fromUrlPath": { - "description": "The content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API).", - "type": "string" - } - }, - "type": "object" - }, - "GdataDiffChecksumsResponse": { - "description": "Backend response for a Diff get checksums response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.", - "id": "GdataDiffChecksumsResponse", - "properties": { - "checksumsLocation": { - "$ref": "GdataCompositeMedia", - "description": "Exactly one of these fields must be populated. If checksums_location is filled, the server will return the corresponding contents to the user. If object_location is filled, the server will calculate the checksums based on the content there and return that to the user. For details on the format of the checksums, see http://go/scotty-diff-protocol." - }, - "chunkSizeBytes": { - "description": "The chunk size of checksums. Must be a multiple of 256KB.", - "format": "int64", - "type": "string" - }, - "objectLocation": { - "$ref": "GdataCompositeMedia", - "description": "If set, calculate the checksums based on the contents and return them to the caller." - }, - "objectSizeBytes": { - "description": "The total size of the server object.", - "format": "int64", - "type": "string" - }, - "objectVersion": { - "description": "The object version of the object the checksums are being returned for.", - "type": "string" - } - }, - "type": "object" - }, - "GdataDiffDownloadResponse": { - "description": "Backend response for a Diff download response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.", - "id": "GdataDiffDownloadResponse", - "properties": { - "objectLocation": { - "$ref": "GdataCompositeMedia", - "description": "The original object location." - } - }, - "type": "object" - }, - "GdataDiffUploadRequest": { - "description": "A Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.", - "id": "GdataDiffUploadRequest", - "properties": { - "checksumsInfo": { - "$ref": "GdataCompositeMedia", - "description": "The location of the checksums for the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received. For details on the format of the checksums, see http://go/scotty-diff-protocol." - }, - "objectInfo": { - "$ref": "GdataCompositeMedia", - "description": "The location of the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received." - }, - "objectVersion": { - "description": "The object version of the object that is the base version the incoming diff script will be applied to. This field will always be filled in.", - "type": "string" - } - }, - "type": "object" - }, - "GdataDiffUploadResponse": { - "description": "Backend response for a Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.", - "id": "GdataDiffUploadResponse", - "properties": { - "objectVersion": { - "description": "The object version of the object at the server. Must be included in the end notification response. The version in the end notification response must correspond to the new version of the object that is now stored at the server, after the upload.", - "type": "string" - }, - "originalObject": { - "$ref": "GdataCompositeMedia", - "description": "The location of the original file for a diff upload request. Must be filled in if responding to an upload start notification." - } - }, - "type": "object" - }, - "GdataDiffVersionResponse": { - "description": "Backend response for a Diff get version response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.", - "id": "GdataDiffVersionResponse", - "properties": { - "objectSizeBytes": { - "description": "The total size of the server object.", - "format": "int64", - "type": "string" - }, - "objectVersion": { - "description": "The version of the object stored at the server.", - "type": "string" - } - }, - "type": "object" - }, - "GdataDownloadParameters": { - "description": "Parameters specific to media downloads.", - "id": "GdataDownloadParameters", - "properties": { - "allowGzipCompression": { - "description": "A boolean to be returned in the response to Scotty. Allows/disallows gzip encoding of the payload content when the server thinks it's advantageous (hence, does not guarantee compression) which allows Scotty to GZip the response to the client.", - "type": "boolean" - }, - "ignoreRange": { - "description": "Determining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty.", - "type": "boolean" - } - }, - "type": "object" - }, - "GdataMedia": { - "description": "A reference to data stored on the filesystem, on GFS or in blobstore.", - "id": "GdataMedia", - "properties": { - "algorithm": { - "deprecated": true, - "description": "Deprecated, use one of explicit hash type fields instead. Algorithm used for calculating the hash. As of 2011/01/21, \"MD5\" is the only possible value for this field. New values may be added at any time.", - "type": "string" - }, - "bigstoreObjectRef": { - "deprecated": true, - "description": "Use object_id instead.", - "format": "byte", - "type": "string" - }, - "blobRef": { - "deprecated": true, - "description": "Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.", - "format": "byte", - "type": "string" - }, - "blobstore2Info": { - "$ref": "GdataBlobstore2Info", - "description": "Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob." - }, - "compositeMedia": { - "description": "A composite media composed of one or more media objects, set if reference_type is COMPOSITE_MEDIA. The media length field must be set to the sum of the lengths of all composite media objects. Note: All composite media must have length specified.", - "items": { - "$ref": "GdataCompositeMedia" - }, - "type": "array" - }, - "contentType": { - "description": "MIME type of the data", - "type": "string" - }, - "contentTypeInfo": { - "$ref": "GdataContentTypeInfo", - "description": "Extended content type information provided for Scotty uploads." - }, - "cosmoBinaryReference": { - "description": "A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.", - "format": "byte", - "type": "string" - }, - "crc32cHash": { - "description": "For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported.", - "format": "uint32", - "type": "integer" - }, - "diffChecksumsResponse": { - "$ref": "GdataDiffChecksumsResponse", - "description": "Set if reference_type is DIFF_CHECKSUMS_RESPONSE." - }, - "diffDownloadResponse": { - "$ref": "GdataDiffDownloadResponse", - "description": "Set if reference_type is DIFF_DOWNLOAD_RESPONSE." - }, - "diffUploadRequest": { - "$ref": "GdataDiffUploadRequest", - "description": "Set if reference_type is DIFF_UPLOAD_REQUEST." - }, - "diffUploadResponse": { - "$ref": "GdataDiffUploadResponse", - "description": "Set if reference_type is DIFF_UPLOAD_RESPONSE." - }, - "diffVersionResponse": { - "$ref": "GdataDiffVersionResponse", - "description": "Set if reference_type is DIFF_VERSION_RESPONSE." - }, - "downloadParameters": { - "$ref": "GdataDownloadParameters", - "description": "Parameters for a media download." - }, - "filename": { - "description": "Original file name", - "type": "string" - }, - "hash": { - "deprecated": true, - "description": "Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto\u0026q=class:Hash Hex encoded hash value of the uploaded media.", - "type": "string" - }, - "hashVerified": { - "description": "For Scotty uploads only. If a user sends a hash code and the backend has requested that Scotty verify the upload against the client hash, Scotty will perform the check on behalf of the backend and will reject it if the hashes don't match. This is set to true if Scotty performed this verification.", - "type": "boolean" - }, - "inline": { - "description": "Media data, set if reference_type is INLINE", - "format": "byte", - "type": "string" - }, - "isPotentialRetry": { - "description": "|is_potential_retry| is set false only when Scotty is certain that it has not sent the request before. When a client resumes an upload, this field must be set true in agent calls, because Scotty cannot be certain that it has never sent the request before due to potential failure in the session state persistence.", - "type": "boolean" - }, - "length": { - "description": "Size of the data, in bytes", - "format": "int64", - "type": "string" - }, - "md5Hash": { - "description": "Scotty-provided MD5 hash for an upload.", - "format": "byte", - "type": "string" - }, - "mediaId": { - "description": "Media id to forward to the operation GetMedia. Can be set if reference_type is GET_MEDIA.", - "format": "byte", - "type": "string" - }, - "objectId": { - "$ref": "GdataObjectId", - "description": "Reference to a TI Blob, set if reference_type is BIGSTORE_REF." - }, - "path": { - "description": "Path to the data, set if reference_type is PATH", - "type": "string" - }, - "referenceType": { - "description": "Describes what the field reference contains.", - "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" - ], - "enumDescriptions": [ - "Reference contains a GFS path or a local path.", - "Reference points to a blobstore object. This could be either a v1 blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info first, since v1 is being deprecated.", - "Data is included into this proto buffer", - "Data should be accessed from the current service using the operation GetMedia.", - "The content for this media object is stored across multiple partial media objects under the composite_media field.", - "Reference points to a bigstore object", - "Indicates the data is stored in diff_version_response.", - "Indicates the data is stored in diff_checksums_response.", - "Indicates the data is stored in diff_download_response.", - "Indicates the data is stored in diff_upload_request.", - "Indicates the data is stored in diff_upload_response.", - "Indicates the data is stored in cosmo_binary_reference.", - "Informs Scotty to generate a response payload with the size specified in the length field. The contents of the payload are generated by Scotty and are undefined. This is useful for testing download speeds between the user and Scotty without involving a real payload source. Note: range is not supported when using arbitrary_bytes." - ], - "type": "string" - }, - "sha1Hash": { - "description": "Scotty-provided SHA1 hash for an upload.", - "format": "byte", - "type": "string" - }, - "sha256Hash": { - "description": "Scotty-provided SHA256 hash for an upload.", - "format": "byte", - "type": "string" - }, - "timestamp": { - "description": "Time at which the media data was last updated, in milliseconds since UNIX epoch", - "format": "uint64", - "type": "string" - }, - "token": { - "description": "A unique fingerprint/version id for the media data", - "type": "string" - } - }, - "type": "object" - }, - "GdataObjectId": { - "description": "This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763.", - "id": "GdataObjectId", - "properties": { - "bucketName": { - "description": "The name of the bucket to which this object belongs.", - "type": "string" - }, - "generation": { - "description": "Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions", - "format": "int64", - "type": "string" - }, - "objectName": { - "description": "The name of the object.", - "type": "string" - } - }, - "type": "object" - }, "GoogleApiDistribution": { "description": "`Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless.", "id": "GoogleApiDistribution", @@ -13007,6 +12426,14 @@ "$ref": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicy", "description": "Optional. Customer policy for the assistant." }, + "description": { + "description": "Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.", + "type": "string" + }, + "displayName": { + "description": "Required. The assistant display name. It must be a UTF-8 encoded string with a length limit of 128 characters.", + "type": "string" + }, "enabledTools": { "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1AssistantToolList" @@ -13121,10 +12548,21 @@ "description": "Configuration for the generation of the assistant response.", "id": "GoogleCloudDiscoveryengineV1AssistantGenerationConfig", "properties": { + "allowedModelIds": { + "description": "Optional. The list of models that are allowed to be used for assistant.", + "items": { + "type": "string" + }, + "type": "array" + }, "defaultLanguage": { "description": "The default language to use for the generation of the assistant response. Use an ISO 639-1 language code such as `en`. If not specified, the language will be automatically detected.", "type": "string" }, + "defaultModelId": { + "description": "Optional. The default model to use for assistant.", + "type": "string" + }, "systemInstruction": { "$ref": "GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction", "description": "System instruction, also known as the prompt preamble for LLM calls. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions" @@ -19072,6 +18510,14 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicy", "description": "Optional. Customer policy for the assistant." }, + "description": { + "description": "Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.", + "type": "string" + }, + "displayName": { + "description": "Required. The assistant display name. It must be a UTF-8 encoded string with a length limit of 128 characters.", + "type": "string" + }, "enabledTools": { "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantToolList" @@ -19290,10 +18736,21 @@ "description": "Configuration for the generation of the assistant response.", "id": "GoogleCloudDiscoveryengineV1alphaAssistantGenerationConfig", "properties": { + "allowedModelIds": { + "description": "Optional. The list of models that are allowed to be used for assistant.", + "items": { + "type": "string" + }, + "type": "array" + }, "defaultLanguage": { "description": "The default language to use for the generation of the assistant response. Use an ISO 639-1 language code such as `en`. If not specified, the language will be automatically detected.", "type": "string" }, + "defaultModelId": { + "description": "Optional. The default model to use for assistant.", + "type": "string" + }, "systemInstruction": { "$ref": "GoogleCloudDiscoveryengineV1alphaAssistantGenerationConfigSystemInstruction", "description": "System instruction, also known as the prompt preamble for LLM calls. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions" @@ -20949,82 +20406,6 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStats": { - "description": "Response for [EstimateBillingService.GetConfigurablePricingUsageStats] method.", - "id": "GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStats", - "properties": { - "metricUsages": { - "description": "A list of metric usages, one for each requested resource type that has data in the requested time range.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStatsMetricUsage" - }, - "type": "array" - }, - "name": { - "description": "Identifier. The name of the ConfigurablePricingUsageStats. Format: projects/{project}/locations/{location}/configurablePricingUsageStats", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStatsDatedUsage": { - "description": "A list of usages for a specific day.", - "id": "GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStatsDatedUsage", - "properties": { - "date": { - "$ref": "GoogleTypeDate", - "description": "The date of the usage." - }, - "usage": { - "description": "The usage value on the date.", - "format": "double", - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStatsMetricUsage": { - "description": "The usage of a metric over a list of days.", - "id": "GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStatsMetricUsage", - "properties": { - "datedUsages": { - "description": "The list of usages for this resource type, chronologically sorted by date. This is populated for metrics with daily aggregation like DAILY_MDN_QPM.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStatsDatedUsage" - }, - "type": "array" - }, - "metricType": { - "description": "The metric type.", - "enum": [ - "BILLING_METRIC_TYPE_UNSPECIFIED", - "DAILY_MDN_QPM", - "DAILY_MIN_QPM", - "DAILY_MAX_QPM", - "DAILY_SEARCH_REQUEST", - "TOTAL_STORAGE" - ], - "enumDescriptions": [ - "Default value.", - "Daily median search request QPM.", - "Daily min search request QPM.", - "Daily max search request QPM.", - "Daily search request total.", - "Total storage bytes for indexing core." - ], - "type": "string" - }, - "totalUsages": { - "description": "The list of total usages for this resource type", - "items": { - "format": "double", - "type": "number" - }, - "type": "array" - } - }, - "type": "object" - }, "GoogleCloudDiscoveryengineV1alphaConnectorRun": { "description": "A data sync run of DataConnector. After DataConnector is successfully initialized, data syncs are scheduled at DataConnector.refresh_interval. A ConnectorRun represents a data sync either in the past or onging that the moment. //", "id": "GoogleCloudDiscoveryengineV1alphaConnectorRun", @@ -25412,6 +24793,24 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaListAssistantsResponse": { + "description": "Response message for the AssistantService.ListAssistants method.", + "id": "GoogleCloudDiscoveryengineV1alphaListAssistantsResponse", + "properties": { + "assistants": { + "description": "All the customer's Assistants.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAssistant" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token that can be sent as ListAssistantsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaListAuthorizationsResponse": { "description": "Response message for the AuthorizationService.ListAuthorizations method.", "id": "GoogleCloudDiscoveryengineV1alphaListAuthorizationsResponse", @@ -26682,6 +26081,75 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponse": { + "description": "Response for [ProjectService.QueryConfigurablePricingUsageStats] method.", + "id": "GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponse", + "properties": { + "metricUsages": { + "description": "A list of metric usages, one for each requested resource type that has data in the requested time range.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponseMetricUsage" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponseDatedUsage": { + "description": "A list of usages for a specific day.", + "id": "GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponseDatedUsage", + "properties": { + "date": { + "$ref": "GoogleTypeDate", + "description": "The date of the usage." + }, + "usage": { + "description": "The usage value on the date.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponseMetricUsage": { + "description": "The usage of a metric over a list of days.", + "id": "GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponseMetricUsage", + "properties": { + "datedUsages": { + "description": "The list of usages for this resource type, chronologically sorted by date. This is populated for metrics with daily aggregation like DAILY_MDN_QPM.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponseDatedUsage" + }, + "type": "array" + }, + "metricType": { + "description": "The metric type.", + "enum": [ + "BILLING_METRIC_TYPE_UNSPECIFIED", + "DAILY_MDN_QPM", + "DAILY_MIN_QPM", + "DAILY_MAX_QPM", + "DAILY_SEARCH_REQUEST", + "TOTAL_STORAGE" + ], + "enumDescriptions": [ + "Default value.", + "Daily median search request QPM.", + "Daily min search request QPM.", + "Daily max search request QPM.", + "Daily search request total.", + "Total storage bytes for indexing core." + ], + "type": "string" + }, + "totalUsage": { + "description": "The total usage for this resource type. This is populated for metrics like TOTAL_STORAGE.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaRankRequest": { "description": "Request message for RankService.Rank method.", "id": "GoogleCloudDiscoveryengineV1alphaRankRequest", @@ -27630,6 +27098,13 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", "description": "A specification for configuring the behavior of content search." }, + "crowdingSpecs": { + "description": "Optional. Crowding specifications for improving result diversity. If multiple CrowdingSpecs are specified, crowding will be evaluated on each unique combination of the `field` values, and max_count will be the maximum value of `max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec has `field` = \"color\" and `max_count` = 3, and the second CrowdingSpec has `field` = \"size\" and `max_count` = 2, then after 3 documents that share the same color AND size have been returned, subsequent ones should be removed or demoted.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec" + }, + "type": "array" + }, "customFineTuningSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", "description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec." @@ -27686,6 +27161,13 @@ "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" }, + "pageCategories": { + "description": "Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. To represent full path of a category, use '\u003e' character to separate different hierarchies. If '\u003e' is part of the category name, replace it with other character(s). For example, `Graphics Cards \u003e RTX\u003e4090 \u003e Founders Edition` where \"RTX \u003e 4090\" represents one level, can be rewritten as `Graphics Cards \u003e RTX_4090 \u003e Founders Edition`", + "items": { + "type": "string" + }, + "type": "array" + }, "pageSize": { "description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.", "format": "int32", @@ -28117,6 +27599,36 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec": { + "description": "Specification for crowding. Crowding improves the diversity of search results by limiting the number of results that share the same field value. For example, crowding on the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will return at most 3 results with the same color across all pages.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec", + "properties": { + "field": { + "description": "The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.", + "type": "string" + }, + "maxCount": { + "description": "The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in `order_by`), later results with the same value are \"crowded away\". If not specified, the default value is 1.", + "format": "int32", + "type": "integer" + }, + "mode": { + "description": "Mode to use for documents that are crowded away.", + "enum": [ + "MODE_UNSPECIFIED", + "DROP_CROWDED_RESULTS", + "DEMOTE_CROWDED_RESULTS_TO_END" + ], + "enumDescriptions": [ + "Unspecified crowding mode. In this case, server behavior defaults to Mode.DROP_CROWDED_RESULTS.", + "Drop crowded results.", + "Demote crowded results to the later pages." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec": { "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec", @@ -29937,6 +29449,13 @@ "description": "A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support.", "type": "string" }, + "invocationTools": { + "description": "The tool names of the tools that were invoked.", + "items": { + "type": "string" + }, + "type": "array" + }, "sessionInfo": { "$ref": "GoogleCloudDiscoveryengineV1alphaStreamAssistResponseSessionInfo", "description": "Session information. Only included in the final StreamAssistResponse of the response stream." @@ -30359,66 +29878,6 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaUploadAgentFileRequest": { - "description": "Request message for the AgentService.UploadAgentFile method.", - "id": "GoogleCloudDiscoveryengineV1alphaUploadAgentFileRequest", - "properties": { - "blob": { - "$ref": "GdataMedia", - "description": "Information about the file being uploaded." - }, - "mediaRequestInfo": { - "$ref": "ApiservingMediaRequestInfo", - "description": "Media upload request metadata." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaUploadAgentFileResponse": { - "description": "Response message for the AgentService.UploadAgentFile method.", - "id": "GoogleCloudDiscoveryengineV1alphaUploadAgentFileResponse", - "properties": { - "agentFile": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAgentFile", - "description": "The uploaded AgentFile." - }, - "mediaResponseInfo": { - "$ref": "ApiservingMediaResponseInfo", - "description": "Media upload response metadata." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaUploadSessionFileRequest": { - "description": "Request for the AssistantService.UploadSessionFile method.", - "id": "GoogleCloudDiscoveryengineV1alphaUploadSessionFileRequest", - "properties": { - "blob": { - "$ref": "GdataMedia", - "description": "Information about the file being uploaded." - }, - "mediaRequestInfo": { - "$ref": "ApiservingMediaRequestInfo", - "description": "Media upload request metadata." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaUploadSessionFileResponse": { - "description": "Response for the AssistantService.UploadSessionFile method.", - "id": "GoogleCloudDiscoveryengineV1alphaUploadSessionFileResponse", - "properties": { - "fileId": { - "description": "The ID of the uploaded file.", - "type": "string" - }, - "mediaResponseInfo": { - "$ref": "ApiservingMediaResponseInfo", - "description": "Media upload response metadata." - } - }, - "type": "object" - }, "GoogleCloudDiscoveryengineV1alphaUserAnnotations": { "description": "Per-user annotations for an Agent, based on UserAnnotation.", "id": "GoogleCloudDiscoveryengineV1alphaUserAnnotations", @@ -34079,6 +33538,13 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec", "description": "A specification for configuring the behavior of content search." }, + "crowdingSpecs": { + "description": "Optional. Crowding specifications for improving result diversity. If multiple CrowdingSpecs are specified, crowding will be evaluated on each unique combination of the `field` values, and max_count will be the maximum value of `max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec has `field` = \"color\" and `max_count` = 3, and the second CrowdingSpec has `field` = \"size\" and `max_count` = 2, then after 3 documents that share the same color AND size have been returned, subsequent ones should be removed or demoted.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec" + }, + "type": "array" + }, "dataStoreSpecs": { "description": "Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", "items": { @@ -34131,6 +33597,13 @@ "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" }, + "pageCategories": { + "description": "Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. To represent full path of a category, use '\u003e' character to separate different hierarchies. If '\u003e' is part of the category name, replace it with other character(s). For example, `Graphics Cards \u003e RTX\u003e4090 \u003e Founders Edition` where \"RTX \u003e 4090\" represents one level, can be rewritten as `Graphics Cards \u003e RTX_4090 \u003e Founders Edition`", + "items": { + "type": "string" + }, + "type": "array" + }, "pageSize": { "description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.", "format": "int32", @@ -34558,6 +34031,36 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec": { + "description": "Specification for crowding. Crowding improves the diversity of search results by limiting the number of results that share the same field value. For example, crowding on the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will return at most 3 results with the same color across all pages.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec", + "properties": { + "field": { + "description": "The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.", + "type": "string" + }, + "maxCount": { + "description": "The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in `order_by`), later results with the same value are \"crowded away\". If not specified, the default value is 1.", + "format": "int32", + "type": "integer" + }, + "mode": { + "description": "Mode to use for documents that are crowded away.", + "enum": [ + "MODE_UNSPECIFIED", + "DROP_CROWDED_RESULTS", + "DEMOTE_CROWDED_RESULTS_TO_END" + ], + "enumDescriptions": [ + "Unspecified crowding mode. In this case, server behavior defaults to Mode.DROP_CROWDED_RESULTS.", + "Drop crowded results.", + "Demote crowded results to the later pages." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec": { "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec", @@ -36018,40 +35521,6 @@ }, "type": "object" }, - "GoogleCloudNotebooklmV1alphaUploadSourceFileRequest": { - "description": "Request for the SourceService.UploadSourceFile method.", - "id": "GoogleCloudNotebooklmV1alphaUploadSourceFileRequest", - "properties": { - "blob": { - "$ref": "GdataMedia", - "description": "Information about the file being uploaded." - }, - "mediaRequestInfo": { - "$ref": "ApiservingMediaRequestInfo", - "description": "Media upload request metadata." - }, - "sourceId": { - "description": "The source id of the associated file. If not set, a source id will be generated and a new tentative source will be created.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudNotebooklmV1alphaUploadSourceFileResponse": { - "description": "Response for the SourceService.UploadSourceFile method.", - "id": "GoogleCloudNotebooklmV1alphaUploadSourceFileResponse", - "properties": { - "mediaResponseInfo": { - "$ref": "ApiservingMediaResponseInfo", - "description": "Media upload response metadata." - }, - "sourceId": { - "$ref": "GoogleCloudNotebooklmV1alphaSourceId", - "description": "The source id of the uploaded source." - } - }, - "type": "object" - }, "GoogleCloudNotebooklmV1alphaUserContent": { "description": "The \"Content\" messages refer to data the user wants to upload.", "id": "GoogleCloudNotebooklmV1alphaUserContent", @@ -36254,7 +35723,7 @@ "type": "array" }, "unreachable": { - "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, diff --git a/discoveryengine/v1alpha/discoveryengine-gen.go b/discoveryengine/v1alpha/discoveryengine-gen.go index 314769cc0a5..91ed08faa6d 100644 --- a/discoveryengine/v1alpha/discoveryengine-gen.go +++ b/discoveryengine/v1alpha/discoveryengine-gen.go @@ -142,7 +142,6 @@ func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, err } s := &Service{client: client, BasePath: basePath, logger: internaloption.GetLogger(opts)} s.BillingAccounts = NewBillingAccountsService(s) - s.Media = NewMediaService(s) s.Projects = NewProjectsService(s) if endpoint != "" { s.BasePath = endpoint @@ -170,8 +169,6 @@ type Service struct { BillingAccounts *BillingAccountsService - Media *MediaService - Projects *ProjectsService } @@ -203,15 +200,6 @@ type BillingAccountsBillingAccountLicenseConfigsService struct { s *Service } -func NewMediaService(s *Service) *MediaService { - rs := &MediaService{s: s} - return rs -} - -type MediaService struct { - s *Service -} - func NewProjectsService(s *Service) *ProjectsService { rs := &ProjectsService{s: s} rs.Locations = NewProjectsLocationsService(s) @@ -728,6 +716,7 @@ type ProjectsLocationsCollectionsEnginesAssistantsService struct { func NewProjectsLocationsCollectionsEnginesAssistantsAgentsService(s *Service) *ProjectsLocationsCollectionsEnginesAssistantsAgentsService { rs := &ProjectsLocationsCollectionsEnginesAssistantsAgentsService{s: s} rs.Files = NewProjectsLocationsCollectionsEnginesAssistantsAgentsFilesService(s) + rs.Operations = NewProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsService(s) return rs } @@ -735,6 +724,8 @@ type ProjectsLocationsCollectionsEnginesAssistantsAgentsService struct { s *Service Files *ProjectsLocationsCollectionsEnginesAssistantsAgentsFilesService + + Operations *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsService } func NewProjectsLocationsCollectionsEnginesAssistantsAgentsFilesService(s *Service) *ProjectsLocationsCollectionsEnginesAssistantsAgentsFilesService { @@ -746,6 +737,15 @@ type ProjectsLocationsCollectionsEnginesAssistantsAgentsFilesService struct { s *Service } +func NewProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsService(s *Service) *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsService { + rs := &ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsService{s: s} + return rs +} + +type ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsService struct { + s *Service +} + func NewProjectsLocationsCollectionsEnginesAssistantsCannedQueriesService(s *Service) *ProjectsLocationsCollectionsEnginesAssistantsCannedQueriesService { rs := &ProjectsLocationsCollectionsEnginesAssistantsCannedQueriesService{s: s} return rs @@ -1349,698 +1349,6 @@ type ProjectsOperationsService struct { s *Service } -// ApiservingMediaRequestInfo: Extra information added to operations that -// support Scotty media requests. -type ApiservingMediaRequestInfo struct { - // CurrentBytes: The number of current bytes uploaded or downloaded. - CurrentBytes int64 `json:"currentBytes,omitempty,string"` - // CustomData: Data to be copied to backend requests. Custom data is returned - // to Scotty in the agent_state field, which Scotty will then provide in - // subsequent upload notifications. - CustomData string `json:"customData,omitempty"` - // DiffObjectVersion: Set if the http request info is diff encoded. The value - // of this field is the version number of the base revision. This is - // corresponding to Apiary's mediaDiffObjectVersion - // (//depot/google3/java/com/google/api/server/media/variable/DiffObjectVersionV - // ariable.java). See go/esf-scotty-diff-upload for more information. - DiffObjectVersion string `json:"diffObjectVersion,omitempty"` - // FinalStatus: The existence of the final_status field indicates that this is - // the last call to the agent for this request_id. - // http://google3/uploader/agent/scotty_agent.proto?l=737&rcl=347601929 - FinalStatus int64 `json:"finalStatus,omitempty"` - // NotificationType: The type of notification received from Scotty. - // - // Possible values: - // "START" - Such requests signals the start of a request containing media - // upload. Only the media field(s) in the inserted/updated resource are set. - // The response should either return an error or succeed. On success, responses - // don't need to contain anything. - // "PROGRESS" - Such requests signals that the upload has progressed and that - // the backend might want to access the media file specified in relevant fields - // in the resource. Only the media field(s) in the inserted/updated resource - // are set. The response should either return an error or succeed. On success, - // responses don't need to contain anything. - // "END" - Such requests signals the end of a request containing media - // upload. END should be handled just like normal Insert/Upload requests, that - // is, they should process the request and return a complete resource in the - // response. Pointers to media data (a GFS path usually) appear in the relevant - // fields in the inserted/updated resource. See gdata.Media in data.proto. - // "RESPONSE_SENT" - Such requests occur after an END and signal that the - // response has been sent back to the client. RESPONSE_SENT is only sent to the - // backend if it is configured to receive them. The response does not need to - // contain anything. - // "ERROR" - Such requests indicate that an error occurred while processing - // the request. ERROR is only sent to the backend if it is configured to - // receive them. It is not guaranteed that all errors will result in this - // notification to the backend, even if the backend requests them. Since these - // requests are just for informational purposes, the response does not need to - // contain anything. - NotificationType string `json:"notificationType,omitempty"` - // PhysicalHeaders: The physical headers provided by RequestReceivedParameters - // in Scotty request. type is uploader_service.KeyValuePairs. - PhysicalHeaders string `json:"physicalHeaders,omitempty"` - // RequestId: The Scotty request ID. - RequestId string `json:"requestId,omitempty"` - // RequestReceivedParamsServingInfo: The partition of the Scotty server - // handling this request. type is - // uploader_service.RequestReceivedParamsServingInfo - // LINT.IfChange(request_received_params_serving_info_annotations) - // LINT.ThenChange() - RequestReceivedParamsServingInfo string `json:"requestReceivedParamsServingInfo,omitempty"` - // TotalBytes: The total size of the file. - TotalBytes int64 `json:"totalBytes,omitempty,string"` - // TotalBytesIsEstimated: Whether the total bytes field contains an estimated - // data. - TotalBytesIsEstimated bool `json:"totalBytesIsEstimated,omitempty"` - // ForceSendFields is a list of field names (e.g. "CurrentBytes") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "CurrentBytes") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s ApiservingMediaRequestInfo) MarshalJSON() ([]byte, error) { - type NoMethod ApiservingMediaRequestInfo - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// ApiservingMediaResponseInfo: This message is for backends to pass their -// scotty media specific fields to ESF. Backend will include this in their -// response message to ESF. Example: ExportFile is an rpc defined for upload -// using scotty from ESF. rpc ExportFile(ExportFileRequest) returns -// (ExportFileResponse) Message ExportFileResponse will include -// apiserving.MediaResponseInfo to tell ESF about data like dynamic_dropzone it -// needs to pass to Scotty. message ExportFileResponse { optional gdata.Media -// blob = 1; optional apiserving.MediaResponseInfo media_response_info = 2 } -type ApiservingMediaResponseInfo struct { - // CustomData: Data to copy from backend response to the next backend requests. - // Custom data is returned to Scotty in the agent_state field, which Scotty - // will then provide in subsequent upload notifications. - CustomData string `json:"customData,omitempty"` - // DataStorageTransform: Specifies any transformation to be applied to data - // before persisting it or retrieving from storage. E.g., encryption options - // for blobstore2. This should be of the form - // uploader_service.DataStorageTransform. - DataStorageTransform string `json:"dataStorageTransform,omitempty"` - // DestinationBlobMintIndex: For the first notification of a |diff_encoded| - // HttpRequestInfo, this is the index of the blob mint that Scotty should use - // when writing the resulting blob. This field is optional. It's not required - // ever, even if `original_object_blob_mint_index` is set. In situations like - // that, we will use the destination blob's mint for the destination blob and - // regular blob ACL checks for the original object. Note: This field is only - // for use by Drive API for diff uploads. - DestinationBlobMintIndex int64 `json:"destinationBlobMintIndex,omitempty"` - // DynamicDropTarget: Specifies the Scotty Drop Target to use for uploads. If - // present in a media response, Scotty does not upload to a standard drop zone. - // Instead, Scotty saves the upload directly to the location specified in this - // drop target. Unlike drop zones, the drop target is the final storage - // location for an upload. So, the agent does not need to clone the blob at the - // end of the upload. The agent is responsible for garbage collecting any - // orphaned blobs that may occur due to aborted uploads. For more information, - // see the drop target design doc here: http://goto/ScottyDropTarget This field - // will be preferred to dynamicDropzone. If provided, the identified field in - // the response must be of the type uploader.agent.DropTarget. - DynamicDropTarget string `json:"dynamicDropTarget,omitempty"` - // DynamicDropzone: Specifies the Scotty dropzone to use for uploads. - DynamicDropzone string `json:"dynamicDropzone,omitempty"` - // MediaForDiff: Diff Updates must respond to a START notification with this - // Media proto to tell Scotty to decode the diff encoded payload and apply the - // diff against this field. If the request was diff encoded, but this field is - // not set, Scotty will treat the encoding as identity. This is corresponding - // to Apiary's DiffUploadResponse.original_object - // (//depot/google3/gdata/rosy/proto/data.proto?l=413). See - // go/esf-scotty-diff-upload for more information. - MediaForDiff *GdataMedia `json:"mediaForDiff,omitempty"` - // OriginalObjectBlobMintIndex: For the first notification of a |diff_encoded| - // HttpRequestInfo, this is the index of the blob mint that Scotty should use - // when reading the original blob. This field is optional. It's not required - // ever, even if `destination_blob_mint_index` is set. In situations like that, - // we will use the destination blob's mint for the destination blob and regular - // blob ACL checks for the original object. Note: This field is only for use by - // Drive API for diff uploads. - OriginalObjectBlobMintIndex int64 `json:"originalObjectBlobMintIndex,omitempty"` - // RequestClass: Request class to use for all Blobstore operations for this - // request. - // - // Possible values: - // "UNKNOWN_REQUEST_CLASS" - Unpopulated request_class in log files will be - // taken as 0 in dremel query. GoogleSQL will try to cast it to enum by - // default. An unused 0 value is added to avoid GoogleSQL casting error. Please - // refer to b/69677280. - // "LATENCY_SENSITIVE" - A latency-sensitive request. - // "PRODUCTION_BATCH" - A request generated by a batch process. - // "BEST_EFFORT" - A best-effort request. - RequestClass string `json:"requestClass,omitempty"` - // ScottyAgentUserId: Requester ID passed along to be recorded in the Scotty - // logs - ScottyAgentUserId int64 `json:"scottyAgentUserId,omitempty,string"` - // ScottyCustomerLog: Customer-specific data to be recorded in the Scotty logs - // type is logs_proto_scotty.CustomerLog - ScottyCustomerLog string `json:"scottyCustomerLog,omitempty"` - // TrafficClassField: Specifies the TrafficClass that Scotty should use for any - // RPCs to fetch the response bytes. Will override the traffic class GTOS of - // the incoming http request. This is a temporary field to facilitate - // whitelisting and experimentation by the bigstore agent only. For instance, - // this does not apply to RTMP reads. WARNING: DO NOT USE WITHOUT PERMISSION - // FROM THE SCOTTY TEAM. - // - // Possible values: - // "BE1" - Application-selectable traffic classes Best effort - // "AF1" - Assured forwarding priority 1 - // "AF2" - Assured forwarding priority 2 - // "AF3" - Assured forwarding priority 3 - // "AF4" - Assured forwarding priority 4 - // "NC1" - Network control - // "NC0" - Network control - // "BE0" - Best effort at high packet loss - // "LLQ" - Low-latency queue (LLQ) best effort (go/llq) - // "LLQ1" - LLQ assured forwarding priority 1 (go/llq2) - // "LLQ2" - LLQ assured forwarding priority 2 (go/llq2) - // "LLQ3" - LLQ assured forwarding priority 3 (go/llq3) - TrafficClassField string `json:"trafficClassField,omitempty"` - // VerifyHashFromHeader: Tells Scotty to verify hashes on the agent's behalf by - // parsing out the X-Goog-Hash header. - VerifyHashFromHeader bool `json:"verifyHashFromHeader,omitempty"` - // ForceSendFields is a list of field names (e.g. "CustomData") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "CustomData") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s ApiservingMediaResponseInfo) MarshalJSON() ([]byte, error) { - type NoMethod ApiservingMediaResponseInfo - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GdataBlobstore2Info: Information to read/write to blobstore2. -type GdataBlobstore2Info struct { - // BlobGeneration: The blob generation id. - BlobGeneration int64 `json:"blobGeneration,omitempty,string"` - // BlobId: The blob id, e.g., /blobstore/prod/playground/scotty - BlobId string `json:"blobId,omitempty"` - // DownloadReadHandle: Read handle passed from Bigstore -> Scotty for a GCS - // download. This is a signed, serialized blobstore2.ReadHandle proto which - // must never be set outside of Bigstore, and is not applicable to non-GCS - // media downloads. - DownloadReadHandle string `json:"downloadReadHandle,omitempty"` - // ReadToken: The blob read token. Needed to read blobs that have not been - // replicated. Might not be available until the final call. - ReadToken string `json:"readToken,omitempty"` - // UploadMetadataContainer: Metadata passed from Blobstore -> Scotty for a new - // GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer - // proto which must never be consumed outside of Bigstore, and is not - // applicable to non-GCS media uploads. - UploadMetadataContainer string `json:"uploadMetadataContainer,omitempty"` - // ForceSendFields is a list of field names (e.g. "BlobGeneration") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "BlobGeneration") to include in - // API requests with the JSON null value. By default, fields with empty values - // are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataBlobstore2Info) MarshalJSON() ([]byte, error) { - type NoMethod GdataBlobstore2Info - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GdataCompositeMedia: A sequence of media data references representing -// composite data. Introduced to support Bigstore composite objects. For -// details, visit http://go/bigstore-composites. -type GdataCompositeMedia struct { - // BlobRef: Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This - // should be the byte representation of a blobstore.BlobRef. Since Blobstore is - // deprecating v1, use blobstore2_info instead. For now, any v2 blob will also - // be represented in this field as v1 BlobRef. - BlobRef string `json:"blobRef,omitempty"` - // Blobstore2Info: Blobstore v2 info, set if reference_type is BLOBSTORE_REF - // and it refers to a v2 blob. - Blobstore2Info *GdataBlobstore2Info `json:"blobstore2Info,omitempty"` - // CosmoBinaryReference: A binary data reference for a media download. Serves - // as a technology-agnostic binary reference in some Google infrastructure. - // This value is a serialized storage_cosmo.BinaryReference proto. Storing it - // as bytes is a hack to get around the fact that the cosmo proto (as well as - // others it includes) doesn't support JavaScript. This prevents us from - // including the actual type of this field. - CosmoBinaryReference string `json:"cosmoBinaryReference,omitempty"` - // Crc32cHash: crc32.c hash for the payload. - Crc32cHash int64 `json:"crc32cHash,omitempty"` - // Inline: Media data, set if reference_type is INLINE - Inline string `json:"inline,omitempty"` - // Length: Size of the data, in bytes - Length int64 `json:"length,omitempty,string"` - // Md5Hash: MD5 hash for the payload. - Md5Hash string `json:"md5Hash,omitempty"` - // ObjectId: Reference to a TI Blob, set if reference_type is BIGSTORE_REF. - ObjectId *GdataObjectId `json:"objectId,omitempty"` - // Path: Path to the data, set if reference_type is PATH - Path string `json:"path,omitempty"` - // ReferenceType: Describes what the field reference contains. - // - // Possible values: - // "PATH" - Reference contains a GFS path or a local path. - // "BLOB_REF" - Reference points to a blobstore object. This could be either - // a v1 blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info - // first, since v1 is being deprecated. - // "INLINE" - Data is included into this proto buffer - // "BIGSTORE_REF" - Reference points to a bigstore object - // "COSMO_BINARY_REFERENCE" - Indicates the data is stored in - // cosmo_binary_reference. - ReferenceType string `json:"referenceType,omitempty"` - // Sha1Hash: SHA-1 hash for the payload. - Sha1Hash string `json:"sha1Hash,omitempty"` - // ForceSendFields is a list of field names (e.g. "BlobRef") to unconditionally - // include in API requests. By default, fields with empty or default values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "BlobRef") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataCompositeMedia) MarshalJSON() ([]byte, error) { - type NoMethod GdataCompositeMedia - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GdataContentTypeInfo: Detailed Content-Type information from Scotty. The -// Content-Type of the media will typically be filled in by the header or -// Scotty's best_guess, but this extended information provides the backend with -// more information so that it can make a better decision if needed. This is -// only used on media upload requests from Scotty. -type GdataContentTypeInfo struct { - // BestGuess: Scotty's best guess of what the content type of the file is. - BestGuess string `json:"bestGuess,omitempty"` - // FromBytes: The content type of the file derived by looking at specific bytes - // (i.e. "magic bytes") of the actual file. - FromBytes string `json:"fromBytes,omitempty"` - // FromFileName: The content type of the file derived from the file extension - // of the original file name used by the client. - FromFileName string `json:"fromFileName,omitempty"` - // FromHeader: The content type of the file as specified in the request - // headers, multipart headers, or RUPIO start request. - FromHeader string `json:"fromHeader,omitempty"` - // FromUrlPath: The content type of the file derived from the file extension of - // the URL path. The URL path is assumed to represent a file name (which is - // typically only true for agents that are providing a REST API). - FromUrlPath string `json:"fromUrlPath,omitempty"` - // ForceSendFields is a list of field names (e.g. "BestGuess") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "BestGuess") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataContentTypeInfo) MarshalJSON() ([]byte, error) { - type NoMethod GdataContentTypeInfo - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GdataDiffChecksumsResponse: Backend response for a Diff get checksums -// response. For details on the Scotty Diff protocol, visit -// http://go/scotty-diff-protocol. -type GdataDiffChecksumsResponse struct { - // ChecksumsLocation: Exactly one of these fields must be populated. If - // checksums_location is filled, the server will return the corresponding - // contents to the user. If object_location is filled, the server will - // calculate the checksums based on the content there and return that to the - // user. For details on the format of the checksums, see - // http://go/scotty-diff-protocol. - ChecksumsLocation *GdataCompositeMedia `json:"checksumsLocation,omitempty"` - // ChunkSizeBytes: The chunk size of checksums. Must be a multiple of 256KB. - ChunkSizeBytes int64 `json:"chunkSizeBytes,omitempty,string"` - // ObjectLocation: If set, calculate the checksums based on the contents and - // return them to the caller. - ObjectLocation *GdataCompositeMedia `json:"objectLocation,omitempty"` - // ObjectSizeBytes: The total size of the server object. - ObjectSizeBytes int64 `json:"objectSizeBytes,omitempty,string"` - // ObjectVersion: The object version of the object the checksums are being - // returned for. - ObjectVersion string `json:"objectVersion,omitempty"` - // ForceSendFields is a list of field names (e.g. "ChecksumsLocation") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "ChecksumsLocation") to include in - // API requests with the JSON null value. By default, fields with empty values - // are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataDiffChecksumsResponse) MarshalJSON() ([]byte, error) { - type NoMethod GdataDiffChecksumsResponse - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GdataDiffDownloadResponse: Backend response for a Diff download response. -// For details on the Scotty Diff protocol, visit -// http://go/scotty-diff-protocol. -type GdataDiffDownloadResponse struct { - // ObjectLocation: The original object location. - ObjectLocation *GdataCompositeMedia `json:"objectLocation,omitempty"` - // ForceSendFields is a list of field names (e.g. "ObjectLocation") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "ObjectLocation") to include in - // API requests with the JSON null value. By default, fields with empty values - // are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataDiffDownloadResponse) MarshalJSON() ([]byte, error) { - type NoMethod GdataDiffDownloadResponse - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GdataDiffUploadRequest: A Diff upload request. For details on the Scotty -// Diff protocol, visit http://go/scotty-diff-protocol. -type GdataDiffUploadRequest struct { - // ChecksumsInfo: The location of the checksums for the new object. Agents must - // clone the object located here, as the upload server will delete the contents - // once a response is received. For details on the format of the checksums, see - // http://go/scotty-diff-protocol. - ChecksumsInfo *GdataCompositeMedia `json:"checksumsInfo,omitempty"` - // ObjectInfo: The location of the new object. Agents must clone the object - // located here, as the upload server will delete the contents once a response - // is received. - ObjectInfo *GdataCompositeMedia `json:"objectInfo,omitempty"` - // ObjectVersion: The object version of the object that is the base version the - // incoming diff script will be applied to. This field will always be filled - // in. - ObjectVersion string `json:"objectVersion,omitempty"` - // ForceSendFields is a list of field names (e.g. "ChecksumsInfo") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "ChecksumsInfo") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataDiffUploadRequest) MarshalJSON() ([]byte, error) { - type NoMethod GdataDiffUploadRequest - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GdataDiffUploadResponse: Backend response for a Diff upload request. For -// details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. -type GdataDiffUploadResponse struct { - // ObjectVersion: The object version of the object at the server. Must be - // included in the end notification response. The version in the end - // notification response must correspond to the new version of the object that - // is now stored at the server, after the upload. - ObjectVersion string `json:"objectVersion,omitempty"` - // OriginalObject: The location of the original file for a diff upload request. - // Must be filled in if responding to an upload start notification. - OriginalObject *GdataCompositeMedia `json:"originalObject,omitempty"` - // ForceSendFields is a list of field names (e.g. "ObjectVersion") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "ObjectVersion") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataDiffUploadResponse) MarshalJSON() ([]byte, error) { - type NoMethod GdataDiffUploadResponse - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GdataDiffVersionResponse: Backend response for a Diff get version response. -// For details on the Scotty Diff protocol, visit -// http://go/scotty-diff-protocol. -type GdataDiffVersionResponse struct { - // ObjectSizeBytes: The total size of the server object. - ObjectSizeBytes int64 `json:"objectSizeBytes,omitempty,string"` - // ObjectVersion: The version of the object stored at the server. - ObjectVersion string `json:"objectVersion,omitempty"` - // ForceSendFields is a list of field names (e.g. "ObjectSizeBytes") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "ObjectSizeBytes") to include in - // API requests with the JSON null value. By default, fields with empty values - // are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataDiffVersionResponse) MarshalJSON() ([]byte, error) { - type NoMethod GdataDiffVersionResponse - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GdataDownloadParameters: Parameters specific to media downloads. -type GdataDownloadParameters struct { - // AllowGzipCompression: A boolean to be returned in the response to Scotty. - // Allows/disallows gzip encoding of the payload content when the server thinks - // it's advantageous (hence, does not guarantee compression) which allows - // Scotty to GZip the response to the client. - AllowGzipCompression bool `json:"allowGzipCompression,omitempty"` - // IgnoreRange: Determining whether or not Apiary should skip the inclusion of - // any Content-Range header on its response to Scotty. - IgnoreRange bool `json:"ignoreRange,omitempty"` - // ForceSendFields is a list of field names (e.g. "AllowGzipCompression") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "AllowGzipCompression") to include - // in API requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataDownloadParameters) MarshalJSON() ([]byte, error) { - type NoMethod GdataDownloadParameters - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GdataMedia: A reference to data stored on the filesystem, on GFS or in -// blobstore. -type GdataMedia struct { - // Algorithm: Deprecated, use one of explicit hash type fields instead. - // Algorithm used for calculating the hash. As of 2011/01/21, "MD5" is the only - // possible value for this field. New values may be added at any time. - Algorithm string `json:"algorithm,omitempty"` - // BigstoreObjectRef: Use object_id instead. - BigstoreObjectRef string `json:"bigstoreObjectRef,omitempty"` - // BlobRef: Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This - // should be the byte representation of a blobstore.BlobRef. Since Blobstore is - // deprecating v1, use blobstore2_info instead. For now, any v2 blob will also - // be represented in this field as v1 BlobRef. - BlobRef string `json:"blobRef,omitempty"` - // Blobstore2Info: Blobstore v2 info, set if reference_type is BLOBSTORE_REF - // and it refers to a v2 blob. - Blobstore2Info *GdataBlobstore2Info `json:"blobstore2Info,omitempty"` - // CompositeMedia: A composite media composed of one or more media objects, set - // if reference_type is COMPOSITE_MEDIA. The media length field must be set to - // the sum of the lengths of all composite media objects. Note: All composite - // media must have length specified. - CompositeMedia []*GdataCompositeMedia `json:"compositeMedia,omitempty"` - // ContentType: MIME type of the data - ContentType string `json:"contentType,omitempty"` - // ContentTypeInfo: Extended content type information provided for Scotty - // uploads. - ContentTypeInfo *GdataContentTypeInfo `json:"contentTypeInfo,omitempty"` - // CosmoBinaryReference: A binary data reference for a media download. Serves - // as a technology-agnostic binary reference in some Google infrastructure. - // This value is a serialized storage_cosmo.BinaryReference proto. Storing it - // as bytes is a hack to get around the fact that the cosmo proto (as well as - // others it includes) doesn't support JavaScript. This prevents us from - // including the actual type of this field. - CosmoBinaryReference string `json:"cosmoBinaryReference,omitempty"` - // Crc32cHash: For Scotty Uploads: Scotty-provided hashes for uploads For - // Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY - // TEAM.) A Hash provided by the agent to be used to verify the data being - // downloaded. Currently only supported for inline payloads. Further, only - // crc32c_hash is currently supported. - Crc32cHash int64 `json:"crc32cHash,omitempty"` - // DiffChecksumsResponse: Set if reference_type is DIFF_CHECKSUMS_RESPONSE. - DiffChecksumsResponse *GdataDiffChecksumsResponse `json:"diffChecksumsResponse,omitempty"` - // DiffDownloadResponse: Set if reference_type is DIFF_DOWNLOAD_RESPONSE. - DiffDownloadResponse *GdataDiffDownloadResponse `json:"diffDownloadResponse,omitempty"` - // DiffUploadRequest: Set if reference_type is DIFF_UPLOAD_REQUEST. - DiffUploadRequest *GdataDiffUploadRequest `json:"diffUploadRequest,omitempty"` - // DiffUploadResponse: Set if reference_type is DIFF_UPLOAD_RESPONSE. - DiffUploadResponse *GdataDiffUploadResponse `json:"diffUploadResponse,omitempty"` - // DiffVersionResponse: Set if reference_type is DIFF_VERSION_RESPONSE. - DiffVersionResponse *GdataDiffVersionResponse `json:"diffVersionResponse,omitempty"` - // DownloadParameters: Parameters for a media download. - DownloadParameters *GdataDownloadParameters `json:"downloadParameters,omitempty"` - // Filename: Original file name - Filename string `json:"filename,omitempty"` - // Hash: Deprecated, use one of explicit hash type fields instead. These two - // hash related fields will only be populated on Scotty based media uploads and - // will contain the content of the hash group in the NotificationRequest: - // http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash - // Hex encoded hash value of the uploaded media. - Hash string `json:"hash,omitempty"` - // HashVerified: For Scotty uploads only. If a user sends a hash code and the - // backend has requested that Scotty verify the upload against the client hash, - // Scotty will perform the check on behalf of the backend and will reject it if - // the hashes don't match. This is set to true if Scotty performed this - // verification. - HashVerified bool `json:"hashVerified,omitempty"` - // Inline: Media data, set if reference_type is INLINE - Inline string `json:"inline,omitempty"` - // IsPotentialRetry: |is_potential_retry| is set false only when Scotty is - // certain that it has not sent the request before. When a client resumes an - // upload, this field must be set true in agent calls, because Scotty cannot be - // certain that it has never sent the request before due to potential failure - // in the session state persistence. - IsPotentialRetry bool `json:"isPotentialRetry,omitempty"` - // Length: Size of the data, in bytes - Length int64 `json:"length,omitempty,string"` - // Md5Hash: Scotty-provided MD5 hash for an upload. - Md5Hash string `json:"md5Hash,omitempty"` - // MediaId: Media id to forward to the operation GetMedia. Can be set if - // reference_type is GET_MEDIA. - MediaId string `json:"mediaId,omitempty"` - // ObjectId: Reference to a TI Blob, set if reference_type is BIGSTORE_REF. - ObjectId *GdataObjectId `json:"objectId,omitempty"` - // Path: Path to the data, set if reference_type is PATH - Path string `json:"path,omitempty"` - // ReferenceType: Describes what the field reference contains. - // - // Possible values: - // "PATH" - Reference contains a GFS path or a local path. - // "BLOB_REF" - Reference points to a blobstore object. This could be either - // a v1 blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info - // first, since v1 is being deprecated. - // "INLINE" - Data is included into this proto buffer - // "GET_MEDIA" - Data should be accessed from the current service using the - // operation GetMedia. - // "COMPOSITE_MEDIA" - The content for this media object is stored across - // multiple partial media objects under the composite_media field. - // "BIGSTORE_REF" - Reference points to a bigstore object - // "DIFF_VERSION_RESPONSE" - Indicates the data is stored in - // diff_version_response. - // "DIFF_CHECKSUMS_RESPONSE" - Indicates the data is stored in - // diff_checksums_response. - // "DIFF_DOWNLOAD_RESPONSE" - Indicates the data is stored in - // diff_download_response. - // "DIFF_UPLOAD_REQUEST" - Indicates the data is stored in - // diff_upload_request. - // "DIFF_UPLOAD_RESPONSE" - Indicates the data is stored in - // diff_upload_response. - // "COSMO_BINARY_REFERENCE" - Indicates the data is stored in - // cosmo_binary_reference. - // "ARBITRARY_BYTES" - Informs Scotty to generate a response payload with the - // size specified in the length field. The contents of the payload are - // generated by Scotty and are undefined. This is useful for testing download - // speeds between the user and Scotty without involving a real payload source. - // Note: range is not supported when using arbitrary_bytes. - ReferenceType string `json:"referenceType,omitempty"` - // Sha1Hash: Scotty-provided SHA1 hash for an upload. - Sha1Hash string `json:"sha1Hash,omitempty"` - // Sha256Hash: Scotty-provided SHA256 hash for an upload. - Sha256Hash string `json:"sha256Hash,omitempty"` - // Timestamp: Time at which the media data was last updated, in milliseconds - // since UNIX epoch - Timestamp uint64 `json:"timestamp,omitempty,string"` - // Token: A unique fingerprint/version id for the media data - Token string `json:"token,omitempty"` - - // ServerResponse contains the HTTP response code and headers from the server. - googleapi.ServerResponse `json:"-"` - // ForceSendFields is a list of field names (e.g. "Algorithm") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Algorithm") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataMedia) MarshalJSON() ([]byte, error) { - type NoMethod GdataMedia - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GdataObjectId: This is a copy of the tech.blob.ObjectId proto, which could -// not be used directly here due to transitive closure issues with JavaScript -// support; see http://b/8801763. -type GdataObjectId struct { - // BucketName: The name of the bucket to which this object belongs. - BucketName string `json:"bucketName,omitempty"` - // Generation: Generation of the object. Generations are monotonically - // increasing across writes, allowing them to be be compared to determine which - // generation is newer. If this is omitted in a request, then you are - // requesting the live object. See http://go/bigstore-versions - Generation int64 `json:"generation,omitempty,string"` - // ObjectName: The name of the object. - ObjectName string `json:"objectName,omitempty"` - // ForceSendFields is a list of field names (e.g. "BucketName") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "BucketName") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataObjectId) MarshalJSON() ([]byte, error) { - type NoMethod GdataObjectId - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - // GoogleApiDistribution: `Distribution` contains summary statistics for a // population of values. It optionally contains a histogram representing the // distribution of those values across a set of buckets. The summary statistics @@ -2996,6 +2304,12 @@ func (s *GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSp type GoogleCloudDiscoveryengineV1Assistant struct { // CustomerPolicy: Optional. Customer policy for the assistant. CustomerPolicy *GoogleCloudDiscoveryengineV1AssistantCustomerPolicy `json:"customerPolicy,omitempty"` + // Description: Optional. Description for additional information. Expected to + // be shown on the configuration UI, not to the users of the assistant. + Description string `json:"description,omitempty"` + // DisplayName: Required. The assistant display name. It must be a UTF-8 + // encoded string with a length limit of 128 characters. + DisplayName string `json:"displayName,omitempty"` // EnabledTools: Optional. Note: not implemented yet. Use enabled_actions // instead. The enabled tools on this assistant. The keys are connector name, // for example @@ -3154,21 +2468,26 @@ func (s GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig) Mar // GoogleCloudDiscoveryengineV1AssistantGenerationConfig: Configuration for the // generation of the assistant response. type GoogleCloudDiscoveryengineV1AssistantGenerationConfig struct { + // AllowedModelIds: Optional. The list of models that are allowed to be used + // for assistant. + AllowedModelIds []string `json:"allowedModelIds,omitempty"` // DefaultLanguage: The default language to use for the generation of the // assistant response. Use an ISO 639-1 language code such as `en`. If not // specified, the language will be automatically detected. DefaultLanguage string `json:"defaultLanguage,omitempty"` + // DefaultModelId: Optional. The default model to use for assistant. + DefaultModelId string `json:"defaultModelId,omitempty"` // SystemInstruction: System instruction, also known as the prompt preamble for // LLM calls. See also // https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions SystemInstruction *GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction `json:"systemInstruction,omitempty"` - // ForceSendFields is a list of field names (e.g. "DefaultLanguage") to + // ForceSendFields is a list of field names (e.g. "AllowedModelIds") to // unconditionally include in API requests. By default, fields with empty or // default values are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "DefaultLanguage") to include in + // NullFields is a list of field names (e.g. "AllowedModelIds") to include in // API requests with the JSON null value. By default, fields with empty values // are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. @@ -10827,6 +10146,12 @@ func (s GoogleCloudDiscoveryengineV1alphaAssistUserMetadata) MarshalJSON() ([]by type GoogleCloudDiscoveryengineV1alphaAssistant struct { // CustomerPolicy: Optional. Customer policy for the assistant. CustomerPolicy *GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicy `json:"customerPolicy,omitempty"` + // Description: Optional. Description for additional information. Expected to + // be shown on the configuration UI, not to the users of the assistant. + Description string `json:"description,omitempty"` + // DisplayName: Required. The assistant display name. It must be a UTF-8 + // encoded string with a length limit of 128 characters. + DisplayName string `json:"displayName,omitempty"` // EnabledTools: Optional. Note: not implemented yet. Use enabled_actions // instead. The enabled tools on this assistant. The keys are connector name, // for example @@ -11128,21 +10453,26 @@ func (s GoogleCloudDiscoveryengineV1alphaAssistantCustomerPolicyModelArmorConfig // GoogleCloudDiscoveryengineV1alphaAssistantGenerationConfig: Configuration // for the generation of the assistant response. type GoogleCloudDiscoveryengineV1alphaAssistantGenerationConfig struct { + // AllowedModelIds: Optional. The list of models that are allowed to be used + // for assistant. + AllowedModelIds []string `json:"allowedModelIds,omitempty"` // DefaultLanguage: The default language to use for the generation of the // assistant response. Use an ISO 639-1 language code such as `en`. If not // specified, the language will be automatically detected. DefaultLanguage string `json:"defaultLanguage,omitempty"` + // DefaultModelId: Optional. The default model to use for assistant. + DefaultModelId string `json:"defaultModelId,omitempty"` // SystemInstruction: System instruction, also known as the prompt preamble for // LLM calls. See also // https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions SystemInstruction *GoogleCloudDiscoveryengineV1alphaAssistantGenerationConfigSystemInstruction `json:"systemInstruction,omitempty"` - // ForceSendFields is a list of field names (e.g. "DefaultLanguage") to + // ForceSendFields is a list of field names (e.g. "AllowedModelIds") to // unconditionally include in API requests. By default, fields with empty or // default values are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "DefaultLanguage") to include in + // NullFields is a list of field names (e.g. "AllowedModelIds") to include in // API requests with the JSON null value. By default, fields with empty values // are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. @@ -13354,129 +12684,6 @@ func (s GoogleCloudDiscoveryengineV1alphaConditionTimeRange) MarshalJSON() ([]by return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStats: Response for -// [EstimateBillingService.GetConfigurablePricingUsageStats] method. -type GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStats struct { - // MetricUsages: A list of metric usages, one for each requested resource type - // that has data in the requested time range. - MetricUsages []*GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStatsMetricUsage `json:"metricUsages,omitempty"` - // Name: Identifier. The name of the ConfigurablePricingUsageStats. Format: - // projects/{project}/locations/{location}/configurablePricingUsageStats - Name string `json:"name,omitempty"` - - // ServerResponse contains the HTTP response code and headers from the server. - googleapi.ServerResponse `json:"-"` - // ForceSendFields is a list of field names (e.g. "MetricUsages") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "MetricUsages") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStats) MarshalJSON() ([]byte, error) { - type NoMethod GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStats - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStatsDatedUsage: A -// list of usages for a specific day. -type GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStatsDatedUsage struct { - // Date: The date of the usage. - Date *GoogleTypeDate `json:"date,omitempty"` - // Usage: The usage value on the date. - Usage float64 `json:"usage,omitempty"` - // ForceSendFields is a list of field names (e.g. "Date") to unconditionally - // include in API requests. By default, fields with empty or default values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Date") to include in API requests - // with the JSON null value. By default, fields with empty values are omitted - // from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStatsDatedUsage) MarshalJSON() ([]byte, error) { - type NoMethod GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStatsDatedUsage - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -func (s *GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStatsDatedUsage) UnmarshalJSON(data []byte) error { - type NoMethod GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStatsDatedUsage - var s1 struct { - Usage gensupport.JSONFloat64 `json:"usage"` - *NoMethod - } - s1.NoMethod = (*NoMethod)(s) - if err := json.Unmarshal(data, &s1); err != nil { - return err - } - s.Usage = float64(s1.Usage) - return nil -} - -// GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStatsMetricUsage: -// The usage of a metric over a list of days. -type GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStatsMetricUsage struct { - // DatedUsages: The list of usages for this resource type, chronologically - // sorted by date. This is populated for metrics with daily aggregation like - // DAILY_MDN_QPM. - DatedUsages []*GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStatsDatedUsage `json:"datedUsages,omitempty"` - // MetricType: The metric type. - // - // Possible values: - // "BILLING_METRIC_TYPE_UNSPECIFIED" - Default value. - // "DAILY_MDN_QPM" - Daily median search request QPM. - // "DAILY_MIN_QPM" - Daily min search request QPM. - // "DAILY_MAX_QPM" - Daily max search request QPM. - // "DAILY_SEARCH_REQUEST" - Daily search request total. - // "TOTAL_STORAGE" - Total storage bytes for indexing core. - MetricType string `json:"metricType,omitempty"` - // TotalUsages: The list of total usages for this resource type - TotalUsages []float64 `json:"totalUsages,omitempty"` - // ForceSendFields is a list of field names (e.g. "DatedUsages") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "DatedUsages") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStatsMetricUsage) MarshalJSON() ([]byte, error) { - type NoMethod GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStatsMetricUsage - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -func (s *GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStatsMetricUsage) UnmarshalJSON(data []byte) error { - type NoMethod GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStatsMetricUsage - var s1 struct { - TotalUsages []gensupport.JSONFloat64 `json:"totalUsages"` - *NoMethod - } - s1.NoMethod = (*NoMethod)(s) - if err := json.Unmarshal(data, &s1); err != nil { - return err - } - s.TotalUsages = make([]float64, len(s1.TotalUsages)) - for i := range s1.TotalUsages { - s.TotalUsages[i] = float64(s1.TotalUsages[i]) - } - return nil -} - // GoogleCloudDiscoveryengineV1alphaConnectorRun: A data sync run of // DataConnector. After DataConnector is successfully initialized, data syncs // are scheduled at DataConnector.refresh_interval. A ConnectorRun represents a @@ -19131,6 +18338,36 @@ func (s GoogleCloudDiscoveryengineV1alphaListAgentsResponse) MarshalJSON() ([]by return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1alphaListAssistantsResponse: Response message +// for the AssistantService.ListAssistants method. +type GoogleCloudDiscoveryengineV1alphaListAssistantsResponse struct { + // Assistants: All the customer's Assistants. + Assistants []*GoogleCloudDiscoveryengineV1alphaAssistant `json:"assistants,omitempty"` + // NextPageToken: A token that can be sent as ListAssistantsRequest.page_token + // to retrieve the next page. If this field is omitted, there are no subsequent + // pages. + NextPageToken string `json:"nextPageToken,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the server. + googleapi.ServerResponse `json:"-"` + // ForceSendFields is a list of field names (e.g. "Assistants") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Assistants") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1alphaListAssistantsResponse) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaListAssistantsResponse + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1alphaListAuthorizationsResponse: Response // message for the AuthorizationService.ListAuthorizations method. type GoogleCloudDiscoveryengineV1alphaListAuthorizationsResponse struct { @@ -21195,6 +20432,124 @@ func (s GoogleCloudDiscoveryengineV1alphaQuery) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponse: +// Response for [ProjectService.QueryConfigurablePricingUsageStats] method. +type GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponse struct { + // MetricUsages: A list of metric usages, one for each requested resource type + // that has data in the requested time range. + MetricUsages []*GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponseMetricUsage `json:"metricUsages,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the server. + googleapi.ServerResponse `json:"-"` + // ForceSendFields is a list of field names (e.g. "MetricUsages") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "MetricUsages") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponse) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponse + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponseDa +// tedUsage: A list of usages for a specific day. +type GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponseDatedUsage struct { + // Date: The date of the usage. + Date *GoogleTypeDate `json:"date,omitempty"` + // Usage: The usage value on the date. + Usage float64 `json:"usage,omitempty"` + // ForceSendFields is a list of field names (e.g. "Date") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Date") to include in API requests + // with the JSON null value. By default, fields with empty values are omitted + // from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponseDatedUsage) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponseDatedUsage + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +func (s *GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponseDatedUsage) UnmarshalJSON(data []byte) error { + type NoMethod GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponseDatedUsage + var s1 struct { + Usage gensupport.JSONFloat64 `json:"usage"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.Usage = float64(s1.Usage) + return nil +} + +// GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponseMe +// tricUsage: The usage of a metric over a list of days. +type GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponseMetricUsage struct { + // DatedUsages: The list of usages for this resource type, chronologically + // sorted by date. This is populated for metrics with daily aggregation like + // DAILY_MDN_QPM. + DatedUsages []*GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponseDatedUsage `json:"datedUsages,omitempty"` + // MetricType: The metric type. + // + // Possible values: + // "BILLING_METRIC_TYPE_UNSPECIFIED" - Default value. + // "DAILY_MDN_QPM" - Daily median search request QPM. + // "DAILY_MIN_QPM" - Daily min search request QPM. + // "DAILY_MAX_QPM" - Daily max search request QPM. + // "DAILY_SEARCH_REQUEST" - Daily search request total. + // "TOTAL_STORAGE" - Total storage bytes for indexing core. + MetricType string `json:"metricType,omitempty"` + // TotalUsage: The total usage for this resource type. This is populated for + // metrics like TOTAL_STORAGE. + TotalUsage float64 `json:"totalUsage,omitempty"` + // ForceSendFields is a list of field names (e.g. "DatedUsages") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "DatedUsages") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponseMetricUsage) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponseMetricUsage + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +func (s *GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponseMetricUsage) UnmarshalJSON(data []byte) error { + type NoMethod GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponseMetricUsage + var s1 struct { + TotalUsage gensupport.JSONFloat64 `json:"totalUsage"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.TotalUsage = float64(s1.TotalUsage) + return nil +} + // GoogleCloudDiscoveryengineV1alphaRankRequest: Request message for // RankService.Rank method. type GoogleCloudDiscoveryengineV1alphaRankRequest struct { @@ -22491,6 +21846,15 @@ type GoogleCloudDiscoveryengineV1alphaSearchRequest struct { // ContentSearchSpec: A specification for configuring the behavior of content // search. ContentSearchSpec *GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec `json:"contentSearchSpec,omitempty"` + // CrowdingSpecs: Optional. Crowding specifications for improving result + // diversity. If multiple CrowdingSpecs are specified, crowding will be + // evaluated on each unique combination of the `field` values, and max_count + // will be the maximum value of `max_count` across all CrowdingSpecs. For + // example, if the first CrowdingSpec has `field` = "color" and `max_count` = + // 3, and the second CrowdingSpec has `field` = "size" and `max_count` = 2, + // then after 3 documents that share the same color AND size have been + // returned, subsequent ones should be removed or demoted. + CrowdingSpecs []*GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec `json:"crowdingSpecs,omitempty"` // CustomFineTuningSpec: Custom fine tuning configs. If set, it has higher // priority than the configs set in ServingConfig.custom_fine_tuning_spec. CustomFineTuningSpec *GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec `json:"customFineTuningSpec,omitempty"` @@ -22560,6 +21924,17 @@ type GoogleCloudDiscoveryengineV1alphaSearchRequest struct { // (https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). // If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. OrderBy string `json:"orderBy,omitempty"` + // PageCategories: Optional. The categories associated with a category page. + // Must be set for category navigation queries to achieve good search quality. + // The format should be the same as UserEvent.PageInfo.page_category. This + // field is the equivalent of the query for browse (navigation) queries. It's + // used by the browse model when the query is empty. If the field is empty, it + // will not be used by the browse model. To represent full path of a category, + // use '>' character to separate different hierarchies. If '>' is part of the + // category name, replace it with other character(s). For example, `Graphics + // Cards > RTX>4090 > Founders Edition` where "RTX > 4090" represents one + // level, can be rewritten as `Graphics Cards > RTX_4090 > Founders Edition` + PageCategories []string `json:"pageCategories,omitempty"` // PageSize: Maximum number of Documents to return. The maximum allowed value // depends on the data type. Values above the maximum value are coerced to the // maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * @@ -23296,6 +22671,48 @@ func (s GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySp return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec: Specification +// for crowding. Crowding improves the diversity of search results by limiting +// the number of results that share the same field value. For example, crowding +// on the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will +// return at most 3 results with the same color across all pages. +type GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec struct { + // Field: The field to use for crowding. Documents can be crowded by a field in + // the Document object. Crowding field is case sensitive. + Field string `json:"field,omitempty"` + // MaxCount: The maximum number of documents to keep per value of the field. + // Once there are at least max_count previous results which contain the same + // value for the given field (according to the order specified in `order_by`), + // later results with the same value are "crowded away". If not specified, the + // default value is 1. + MaxCount int64 `json:"maxCount,omitempty"` + // Mode: Mode to use for documents that are crowded away. + // + // Possible values: + // "MODE_UNSPECIFIED" - Unspecified crowding mode. In this case, server + // behavior defaults to Mode.DROP_CROWDED_RESULTS. + // "DROP_CROWDED_RESULTS" - Drop crowded results. + // "DEMOTE_CROWDED_RESULTS_TO_END" - Demote crowded results to the later + // pages. + Mode string `json:"mode,omitempty"` + // ForceSendFields is a list of field names (e.g. "Field") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Field") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec: A struct to // define data stores to filter on in a search call and configurations for // those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -25833,6 +25250,8 @@ type GoogleCloudDiscoveryengineV1alphaStreamAssistResponse struct { // AssistToken: A global unique ID that identifies the current pair of request // and stream of responses. Used for feedback and support. AssistToken string `json:"assistToken,omitempty"` + // InvocationTools: The tool names of the tools that were invoked. + InvocationTools []string `json:"invocationTools,omitempty"` // SessionInfo: Session information. Only included in the final // StreamAssistResponse of the response stream. SessionInfo *GoogleCloudDiscoveryengineV1alphaStreamAssistResponseSessionInfo `json:"sessionInfo,omitempty"` @@ -26470,109 +25889,6 @@ func (s GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata) MarshalJSON() return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudDiscoveryengineV1alphaUploadAgentFileRequest: Request message for -// the AgentService.UploadAgentFile method. -type GoogleCloudDiscoveryengineV1alphaUploadAgentFileRequest struct { - // Blob: Information about the file being uploaded. - Blob *GdataMedia `json:"blob,omitempty"` - // MediaRequestInfo: Media upload request metadata. - MediaRequestInfo *ApiservingMediaRequestInfo `json:"mediaRequestInfo,omitempty"` - // ForceSendFields is a list of field names (e.g. "Blob") to unconditionally - // include in API requests. By default, fields with empty or default values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Blob") to include in API requests - // with the JSON null value. By default, fields with empty values are omitted - // from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GoogleCloudDiscoveryengineV1alphaUploadAgentFileRequest) MarshalJSON() ([]byte, error) { - type NoMethod GoogleCloudDiscoveryengineV1alphaUploadAgentFileRequest - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GoogleCloudDiscoveryengineV1alphaUploadAgentFileResponse: Response message -// for the AgentService.UploadAgentFile method. -type GoogleCloudDiscoveryengineV1alphaUploadAgentFileResponse struct { - // AgentFile: The uploaded AgentFile. - AgentFile *GoogleCloudDiscoveryengineV1alphaAgentFile `json:"agentFile,omitempty"` - // MediaResponseInfo: Media upload response metadata. - MediaResponseInfo *ApiservingMediaResponseInfo `json:"mediaResponseInfo,omitempty"` - // ForceSendFields is a list of field names (e.g. "AgentFile") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "AgentFile") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GoogleCloudDiscoveryengineV1alphaUploadAgentFileResponse) MarshalJSON() ([]byte, error) { - type NoMethod GoogleCloudDiscoveryengineV1alphaUploadAgentFileResponse - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GoogleCloudDiscoveryengineV1alphaUploadSessionFileRequest: Request for the -// AssistantService.UploadSessionFile method. -type GoogleCloudDiscoveryengineV1alphaUploadSessionFileRequest struct { - // Blob: Information about the file being uploaded. - Blob *GdataMedia `json:"blob,omitempty"` - // MediaRequestInfo: Media upload request metadata. - MediaRequestInfo *ApiservingMediaRequestInfo `json:"mediaRequestInfo,omitempty"` - // ForceSendFields is a list of field names (e.g. "Blob") to unconditionally - // include in API requests. By default, fields with empty or default values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Blob") to include in API requests - // with the JSON null value. By default, fields with empty values are omitted - // from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GoogleCloudDiscoveryengineV1alphaUploadSessionFileRequest) MarshalJSON() ([]byte, error) { - type NoMethod GoogleCloudDiscoveryengineV1alphaUploadSessionFileRequest - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GoogleCloudDiscoveryengineV1alphaUploadSessionFileResponse: Response for the -// AssistantService.UploadSessionFile method. -type GoogleCloudDiscoveryengineV1alphaUploadSessionFileResponse struct { - // FileId: The ID of the uploaded file. - FileId string `json:"fileId,omitempty"` - // MediaResponseInfo: Media upload response metadata. - MediaResponseInfo *ApiservingMediaResponseInfo `json:"mediaResponseInfo,omitempty"` - - // ServerResponse contains the HTTP response code and headers from the server. - googleapi.ServerResponse `json:"-"` - // ForceSendFields is a list of field names (e.g. "FileId") to unconditionally - // include in API requests. By default, fields with empty or default values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "FileId") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GoogleCloudDiscoveryengineV1alphaUploadSessionFileResponse) MarshalJSON() ([]byte, error) { - type NoMethod GoogleCloudDiscoveryengineV1alphaUploadSessionFileResponse - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - // GoogleCloudDiscoveryengineV1alphaUserAnnotations: Per-user annotations for // an Agent, based on UserAnnotation. type GoogleCloudDiscoveryengineV1alphaUserAnnotations struct { @@ -31170,6 +30486,15 @@ type GoogleCloudDiscoveryengineV1betaSearchRequest struct { // ContentSearchSpec: A specification for configuring the behavior of content // search. ContentSearchSpec *GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec `json:"contentSearchSpec,omitempty"` + // CrowdingSpecs: Optional. Crowding specifications for improving result + // diversity. If multiple CrowdingSpecs are specified, crowding will be + // evaluated on each unique combination of the `field` values, and max_count + // will be the maximum value of `max_count` across all CrowdingSpecs. For + // example, if the first CrowdingSpec has `field` = "color" and `max_count` = + // 3, and the second CrowdingSpec has `field` = "size" and `max_count` = 2, + // then after 3 documents that share the same color AND size have been + // returned, subsequent ones should be removed or demoted. + CrowdingSpecs []*GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec `json:"crowdingSpecs,omitempty"` // DataStoreSpecs: Specifications that define the specific DataStores to be // searched, along with configurations for those data stores. This is only // considered for Engines with multiple data stores. For engines with a single @@ -31236,6 +30561,17 @@ type GoogleCloudDiscoveryengineV1betaSearchRequest struct { // (https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). // If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. OrderBy string `json:"orderBy,omitempty"` + // PageCategories: Optional. The categories associated with a category page. + // Must be set for category navigation queries to achieve good search quality. + // The format should be the same as UserEvent.PageInfo.page_category. This + // field is the equivalent of the query for browse (navigation) queries. It's + // used by the browse model when the query is empty. If the field is empty, it + // will not be used by the browse model. To represent full path of a category, + // use '>' character to separate different hierarchies. If '>' is part of the + // category name, replace it with other character(s). For example, `Graphics + // Cards > RTX>4090 > Founders Edition` where "RTX > 4090" represents one + // level, can be rewritten as `Graphics Cards > RTX_4090 > Founders Edition` + PageCategories []string `json:"pageCategories,omitempty"` // PageSize: Maximum number of Documents to return. The maximum allowed value // depends on the data type. Values above the maximum value are coerced to the // maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * @@ -31967,6 +31303,48 @@ func (s GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpe return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec: Specification for +// crowding. Crowding improves the diversity of search results by limiting the +// number of results that share the same field value. For example, crowding on +// the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will +// return at most 3 results with the same color across all pages. +type GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec struct { + // Field: The field to use for crowding. Documents can be crowded by a field in + // the Document object. Crowding field is case sensitive. + Field string `json:"field,omitempty"` + // MaxCount: The maximum number of documents to keep per value of the field. + // Once there are at least max_count previous results which contain the same + // value for the given field (according to the order specified in `order_by`), + // later results with the same value are "crowded away". If not specified, the + // default value is 1. + MaxCount int64 `json:"maxCount,omitempty"` + // Mode: Mode to use for documents that are crowded away. + // + // Possible values: + // "MODE_UNSPECIFIED" - Unspecified crowding mode. In this case, server + // behavior defaults to Mode.DROP_CROWDED_RESULTS. + // "DROP_CROWDED_RESULTS" - Drop crowded results. + // "DEMOTE_CROWDED_RESULTS_TO_END" - Demote crowded results to the later + // pages. + Mode string `json:"mode,omitempty"` + // ForceSendFields is a list of field names (e.g. "Field") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Field") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec: A struct to // define data stores to filter on in a search call and configurations for // those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -33981,62 +33359,6 @@ func (s GoogleCloudNotebooklmV1alphaSourceSettings) MarshalJSON() ([]byte, error return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -// GoogleCloudNotebooklmV1alphaUploadSourceFileRequest: Request for the -// SourceService.UploadSourceFile method. -type GoogleCloudNotebooklmV1alphaUploadSourceFileRequest struct { - // Blob: Information about the file being uploaded. - Blob *GdataMedia `json:"blob,omitempty"` - // MediaRequestInfo: Media upload request metadata. - MediaRequestInfo *ApiservingMediaRequestInfo `json:"mediaRequestInfo,omitempty"` - // SourceId: The source id of the associated file. If not set, a source id will - // be generated and a new tentative source will be created. - SourceId string `json:"sourceId,omitempty"` - // ForceSendFields is a list of field names (e.g. "Blob") to unconditionally - // include in API requests. By default, fields with empty or default values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Blob") to include in API requests - // with the JSON null value. By default, fields with empty values are omitted - // from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GoogleCloudNotebooklmV1alphaUploadSourceFileRequest) MarshalJSON() ([]byte, error) { - type NoMethod GoogleCloudNotebooklmV1alphaUploadSourceFileRequest - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GoogleCloudNotebooklmV1alphaUploadSourceFileResponse: Response for the -// SourceService.UploadSourceFile method. -type GoogleCloudNotebooklmV1alphaUploadSourceFileResponse struct { - // MediaResponseInfo: Media upload response metadata. - MediaResponseInfo *ApiservingMediaResponseInfo `json:"mediaResponseInfo,omitempty"` - // SourceId: The source id of the uploaded source. - SourceId *GoogleCloudNotebooklmV1alphaSourceId `json:"sourceId,omitempty"` - - // ServerResponse contains the HTTP response code and headers from the server. - googleapi.ServerResponse `json:"-"` - // ForceSendFields is a list of field names (e.g. "MediaResponseInfo") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "MediaResponseInfo") to include in - // API requests with the JSON null value. By default, fields with empty values - // are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GoogleCloudNotebooklmV1alphaUploadSourceFileResponse) MarshalJSON() ([]byte, error) { - type NoMethod GoogleCloudNotebooklmV1alphaUploadSourceFileResponse - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - // GoogleCloudNotebooklmV1alphaUserContent: The "Content" messages refer to // data the user wants to upload. type GoogleCloudNotebooklmV1alphaUserContent struct { @@ -34461,8 +33783,8 @@ type GoogleLongrunningListOperationsResponse struct { Operations []*GoogleLongrunningOperation `json:"operations,omitempty"` // Unreachable: Unordered list. Unreachable resources. Populated when the // request sets `ListOperationsRequest.return_partial_success` and reads across - // collections e.g. when attempting to list all resources across all supported - // locations. + // collections. For example, when attempting to list all resources across all + // supported locations. Unreachable []string `json:"unreachable,omitempty"` // ServerResponse contains the HTTP response code and headers from the server. @@ -35415,317 +34737,6 @@ func (c *BillingAccountsBillingAccountLicenseConfigsRetractLicenseConfigCall) Do return ret, nil } -type MediaDownloadCall struct { - s *Service - name string - urlParams_ gensupport.URLParams - ifNoneMatch_ string - ctx_ context.Context - header_ http.Header -} - -// Download: Downloads a file from the session. -// -// - name: The resource name of the Session. Format: -// `projects/{project}/locations/{location}/collections/{collection}/engines/{ -// engine}/sessions/{session}`. -func (r *MediaService) Download(name string) *MediaDownloadCall { - c := &MediaDownloadCall{s: r.s, urlParams_: make(gensupport.URLParams)} - c.name = name - return c -} - -// FileId sets the optional parameter "fileId": Required. The ID of the file to -// be downloaded. -func (c *MediaDownloadCall) FileId(fileId string) *MediaDownloadCall { - c.urlParams_.Set("fileId", fileId) - return c -} - -// ViewId sets the optional parameter "viewId": The ID of the view to be -// downloaded. -func (c *MediaDownloadCall) ViewId(viewId string) *MediaDownloadCall { - c.urlParams_.Set("viewId", viewId) - return c -} - -// Fields allows partial responses to be retrieved. See -// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more -// details. -func (c *MediaDownloadCall) Fields(s ...googleapi.Field) *MediaDownloadCall { - c.urlParams_.Set("fields", googleapi.CombineFields(s)) - return c -} - -// IfNoneMatch sets an optional parameter which makes the operation fail if the -// object's ETag matches the given value. This is useful for getting updates -// only after the object has changed since the last request. -func (c *MediaDownloadCall) IfNoneMatch(entityTag string) *MediaDownloadCall { - c.ifNoneMatch_ = entityTag - return c -} - -// Context sets the context to be used in this call's Do and Download methods. -func (c *MediaDownloadCall) Context(ctx context.Context) *MediaDownloadCall { - c.ctx_ = ctx - return c -} - -// Header returns a http.Header that can be modified by the caller to add -// headers to the request. -func (c *MediaDownloadCall) Header() http.Header { - if c.header_ == nil { - c.header_ = make(http.Header) - } - return c.header_ -} - -func (c *MediaDownloadCall) doRequest(alt string) (*http.Response, error) { - reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_) - if c.ifNoneMatch_ != "" { - reqHeaders.Set("If-None-Match", c.ifNoneMatch_) - } - c.urlParams_.Set("alt", alt) - c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "v1alpha/{+name}:downloadFile") - urls += "?" + c.urlParams_.Encode() - req, err := http.NewRequest("GET", urls, nil) - if err != nil { - return nil, err - } - req.Header = reqHeaders - googleapi.Expand(req.URL, map[string]string{ - "name": c.name, - }) - c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "discoveryengine.media.download", "request", internallog.HTTPRequest(req, nil)) - return gensupport.SendRequest(c.ctx_, c.s.client, req) -} - -// Download fetches the API endpoint's "media" value, instead of the normal -// API response value. If the returned error is nil, the Response is guaranteed to -// have a 2xx status code. Callers must close the Response.Body as usual. -func (c *MediaDownloadCall) Download(opts ...googleapi.CallOption) (*http.Response, error) { - gensupport.SetOptions(c.urlParams_, opts...) - res, err := c.doRequest("media") - if err != nil { - return nil, err - } - if err := googleapi.CheckResponse(res); err != nil { - res.Body.Close() - return nil, gensupport.WrapError(err) - } - return res, nil -} - -// Do executes the "discoveryengine.media.download" call. -// Any non-2xx status code is an error. Response headers are in either -// *GdataMedia.ServerResponse.Header or (if a response was returned at all) in -// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check -// whether the returned error was because http.StatusNotModified was returned. -func (c *MediaDownloadCall) Do(opts ...googleapi.CallOption) (*GdataMedia, error) { - gensupport.SetOptions(c.urlParams_, opts...) - res, err := c.doRequest("json") - if res != nil && res.StatusCode == http.StatusNotModified { - if res.Body != nil { - res.Body.Close() - } - return nil, gensupport.WrapError(&googleapi.Error{ - Code: res.StatusCode, - Header: res.Header, - }) - } - if err != nil { - return nil, err - } - defer googleapi.CloseBody(res) - if err := googleapi.CheckResponse(res); err != nil { - return nil, gensupport.WrapError(err) - } - ret := &GdataMedia{ - ServerResponse: googleapi.ServerResponse{ - Header: res.Header, - HTTPStatusCode: res.StatusCode, - }, - } - target := &ret - b, err := gensupport.DecodeResponseBytes(target, res) - if err != nil { - return nil, err - } - c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "discoveryengine.media.download", "response", internallog.HTTPResponse(res, b)) - return ret, nil -} - -type MediaUploadCall struct { - s *Service - name string - googleclouddiscoveryenginev1alphauploadsessionfilerequest *GoogleCloudDiscoveryengineV1alphaUploadSessionFileRequest - urlParams_ gensupport.URLParams - mediaInfo_ *gensupport.MediaInfo - ctx_ context.Context - header_ http.Header -} - -// Upload: Uploads a file for the assistant to use as a source of information -// within the session. -// -// - name: The resource name of the Session. Format: -// `projects/{project}/locations/{location}/collections/{collection}/engines/{ -// engine}/sessions/{session}`. -func (r *MediaService) Upload(name string, googleclouddiscoveryenginev1alphauploadsessionfilerequest *GoogleCloudDiscoveryengineV1alphaUploadSessionFileRequest) *MediaUploadCall { - c := &MediaUploadCall{s: r.s, urlParams_: make(gensupport.URLParams)} - c.name = name - c.googleclouddiscoveryenginev1alphauploadsessionfilerequest = googleclouddiscoveryenginev1alphauploadsessionfilerequest - return c -} - -// Media specifies the media to upload in one or more chunks. The chunk size -// may be controlled by supplying a MediaOption generated by -// googleapi.ChunkSize. The chunk size defaults to -// googleapi.DefaultUploadChunkSize.The Content-Type header used in the upload -// request will be determined by sniffing the contents of r, unless a -// MediaOption generated by googleapi.ContentType is supplied. -// At most one of Media and ResumableMedia may be set. -func (c *MediaUploadCall) Media(r io.Reader, options ...googleapi.MediaOption) *MediaUploadCall { - c.mediaInfo_ = gensupport.NewInfoFromMedia(r, options) - return c -} - -// ResumableMedia specifies the media to upload in chunks and can be canceled -// with ctx. -// -// Deprecated: use Media instead. -// -// At most one of Media and ResumableMedia may be set. mediaType identifies the -// MIME media type of the upload, such as "image/png". If mediaType is "", it -// will be auto-detected. The provided ctx will supersede any context -// previously provided to the Context method. -func (c *MediaUploadCall) ResumableMedia(ctx context.Context, r io.ReaderAt, size int64, mediaType string) *MediaUploadCall { - c.ctx_ = ctx - c.mediaInfo_ = gensupport.NewInfoFromResumableMedia(r, size, mediaType) - return c -} - -// ProgressUpdater provides a callback function that will be called after every -// chunk. It should be a low-latency function in order to not slow down the -// upload operation. This should only be called when using ResumableMedia (as -// opposed to Media). -func (c *MediaUploadCall) ProgressUpdater(pu googleapi.ProgressUpdater) *MediaUploadCall { - c.mediaInfo_.SetProgressUpdater(pu) - return c -} - -// Fields allows partial responses to be retrieved. See -// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more -// details. -func (c *MediaUploadCall) Fields(s ...googleapi.Field) *MediaUploadCall { - c.urlParams_.Set("fields", googleapi.CombineFields(s)) - return c -} - -// Context sets the context to be used in this call's Do method. -// This context will supersede any context previously provided to the -// ResumableMedia method. -func (c *MediaUploadCall) Context(ctx context.Context) *MediaUploadCall { - c.ctx_ = ctx - return c -} - -// Header returns a http.Header that can be modified by the caller to add -// headers to the request. -func (c *MediaUploadCall) Header() http.Header { - if c.header_ == nil { - c.header_ = make(http.Header) - } - return c.header_ -} - -func (c *MediaUploadCall) doRequest(alt string) (*http.Response, error) { - reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "application/json", c.header_) - body, err := googleapi.WithoutDataWrapper.JSONBuffer(c.googleclouddiscoveryenginev1alphauploadsessionfilerequest) - if err != nil { - return nil, err - } - c.urlParams_.Set("alt", alt) - c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "v1alpha/{+name}:uploadFile") - if c.mediaInfo_ != nil { - urls = googleapi.ResolveRelative(c.s.BasePath, "/upload/v1alpha/{+name}:uploadFile") - c.urlParams_.Set("uploadType", c.mediaInfo_.UploadType()) - } - newBody, getBody, cleanup := c.mediaInfo_.UploadRequest(reqHeaders, body) - defer cleanup() - urls += "?" + c.urlParams_.Encode() - req, err := http.NewRequest("POST", urls, newBody) - if err != nil { - return nil, err - } - req.Header = reqHeaders - req.GetBody = getBody - googleapi.Expand(req.URL, map[string]string{ - "name": c.name, - }) - c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "discoveryengine.media.upload", "request", internallog.HTTPRequest(req, body.Bytes())) - return gensupport.SendRequest(c.ctx_, c.s.client, req) -} - -// Do executes the "discoveryengine.media.upload" call. -// Any non-2xx status code is an error. Response headers are in either -// *GoogleCloudDiscoveryengineV1alphaUploadSessionFileResponse.ServerResponse.He -// ader or (if a response was returned at all) in -// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check -// whether the returned error was because http.StatusNotModified was returned. -func (c *MediaUploadCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDiscoveryengineV1alphaUploadSessionFileResponse, error) { - gensupport.SetOptions(c.urlParams_, opts...) - res, err := c.doRequest("json") - if res != nil && res.StatusCode == http.StatusNotModified { - if res.Body != nil { - res.Body.Close() - } - return nil, gensupport.WrapError(&googleapi.Error{ - Code: res.StatusCode, - Header: res.Header, - }) - } - if err != nil { - return nil, err - } - defer googleapi.CloseBody(res) - if err := googleapi.CheckResponse(res); err != nil { - return nil, gensupport.WrapError(err) - } - rx := c.mediaInfo_.ResumableUpload(res.Header.Get("Location")) - if rx != nil { - rx.Client = c.s.client - rx.UserAgent = c.s.userAgent() - ctx := c.ctx_ - if ctx == nil { - ctx = context.TODO() - } - res, err = rx.Upload(ctx) - if err != nil { - return nil, err - } - defer res.Body.Close() - if err := googleapi.CheckResponse(res); err != nil { - return nil, gensupport.WrapError(err) - } - } - ret := &GoogleCloudDiscoveryengineV1alphaUploadSessionFileResponse{ - ServerResponse: googleapi.ServerResponse{ - Header: res.Header, - HTTPStatusCode: res.StatusCode, - }, - } - target := &ret - b, err := gensupport.DecodeResponseBytes(target, res) - if err != nil { - return nil, err - } - c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "discoveryengine.media.upload", "response", internallog.HTTPResponse(res, b)) - return ret, nil -} - type ProjectsGetCall struct { s *Service name string @@ -36499,22 +35510,135 @@ func (c *ProjectsLocationsGetCmekConfigCall) Do(opts ...googleapi.CallOption) (* return ret, nil } -type ProjectsLocationsGetConfigurablePricingUsageStatsCall struct { +type ProjectsLocationsObtainCrawlRateCall struct { + s *Service + location string + googleclouddiscoveryenginev1alphaobtaincrawlraterequest *GoogleCloudDiscoveryengineV1alphaObtainCrawlRateRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// ObtainCrawlRate: Obtains the time series data of organic or dedicated crawl +// rate for monitoring. When dedicated crawl rate is not set, it will return +// vertex AI's organic crawl rate time series. Organic crawl means Google +// automatically crawl the internet at its own convenience. When dedicated +// crawl rate is set, it will return vertex AI's dedicated crawl rate time +// series. +// +// - location: The location resource where crawl rate management will be +// performed. Format: `projects/{project}/locations/{location}`. +func (r *ProjectsLocationsService) ObtainCrawlRate(location string, googleclouddiscoveryenginev1alphaobtaincrawlraterequest *GoogleCloudDiscoveryengineV1alphaObtainCrawlRateRequest) *ProjectsLocationsObtainCrawlRateCall { + c := &ProjectsLocationsObtainCrawlRateCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.location = location + c.googleclouddiscoveryenginev1alphaobtaincrawlraterequest = googleclouddiscoveryenginev1alphaobtaincrawlraterequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more +// details. +func (c *ProjectsLocationsObtainCrawlRateCall) Fields(s ...googleapi.Field) *ProjectsLocationsObtainCrawlRateCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. +func (c *ProjectsLocationsObtainCrawlRateCall) Context(ctx context.Context) *ProjectsLocationsObtainCrawlRateCall { + c.ctx_ = ctx + return c +} + +// Header returns a http.Header that can be modified by the caller to add +// headers to the request. +func (c *ProjectsLocationsObtainCrawlRateCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsObtainCrawlRateCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "application/json", c.header_) + body, err := googleapi.WithoutDataWrapper.JSONBuffer(c.googleclouddiscoveryenginev1alphaobtaincrawlraterequest) + if err != nil { + return nil, err + } + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1alpha/{+location}:obtainCrawlRate") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "location": c.location, + }) + c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.obtainCrawlRate", "request", internallog.HTTPRequest(req, body.Bytes())) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "discoveryengine.projects.locations.obtainCrawlRate" call. +// Any non-2xx status code is an error. Response headers are in either +// *GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse.ServerResponse.Head +// er or (if a response was returned at all) in +// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check +// whether the returned error was because http.StatusNotModified was returned. +func (c *ProjectsLocationsObtainCrawlRateCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + b, err := gensupport.DecodeResponseBytes(target, res) + if err != nil { + return nil, err + } + c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.obtainCrawlRate", "response", internallog.HTTPResponse(res, b)) + return ret, nil +} + +type ProjectsLocationsQueryConfigurablePricingUsageStatsCall struct { s *Service - name string + project string + location string urlParams_ gensupport.URLParams ifNoneMatch_ string ctx_ context.Context header_ http.Header } -// GetConfigurablePricingUsageStats: Gets configurable pricing usage stats. +// QueryConfigurablePricingUsageStats: Queries configurable pricing usage stats +// for a project. // -// - name: The name of the ConfigurablePricingUsageStats to retrieve. Format: -// projects/{project}/locations/{location}/configurablePricingUsageStats. -func (r *ProjectsLocationsService) GetConfigurablePricingUsageStats(name string) *ProjectsLocationsGetConfigurablePricingUsageStatsCall { - c := &ProjectsLocationsGetConfigurablePricingUsageStatsCall{s: r.s, urlParams_: make(gensupport.URLParams)} - c.name = name +// - location: The location to query usage stats for. +// - project: The project to query usage stats for. Format: projects/{project}. +func (r *ProjectsLocationsService) QueryConfigurablePricingUsageStats(project string, location string) *ProjectsLocationsQueryConfigurablePricingUsageStatsCall { + c := &ProjectsLocationsQueryConfigurablePricingUsageStatsCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.project = project + c.location = location return c } @@ -36529,7 +35653,7 @@ func (r *ProjectsLocationsService) GetConfigurablePricingUsageStats(name string) // "DAILY_MAX_QPM" - Daily max search request QPM. // "DAILY_SEARCH_REQUEST" - Daily search request total. // "TOTAL_STORAGE" - Total storage bytes for indexing core. -func (c *ProjectsLocationsGetConfigurablePricingUsageStatsCall) MetricTypes(metricTypes ...string) *ProjectsLocationsGetConfigurablePricingUsageStatsCall { +func (c *ProjectsLocationsQueryConfigurablePricingUsageStatsCall) MetricTypes(metricTypes ...string) *ProjectsLocationsQueryConfigurablePricingUsageStatsCall { c.urlParams_.SetMulti("metricTypes", append([]string{}, metricTypes...)) return c } @@ -36538,7 +35662,7 @@ func (c *ProjectsLocationsGetConfigurablePricingUsageStatsCall) MetricTypes(metr // 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. -func (c *ProjectsLocationsGetConfigurablePricingUsageStatsCall) TimeRangeEndDateDay(timeRangeEndDateDay int64) *ProjectsLocationsGetConfigurablePricingUsageStatsCall { +func (c *ProjectsLocationsQueryConfigurablePricingUsageStatsCall) TimeRangeEndDateDay(timeRangeEndDateDay int64) *ProjectsLocationsQueryConfigurablePricingUsageStatsCall { c.urlParams_.Set("timeRange.endDate.day", fmt.Sprint(timeRangeEndDateDay)) return c } @@ -36546,7 +35670,7 @@ func (c *ProjectsLocationsGetConfigurablePricingUsageStatsCall) TimeRangeEndDate // TimeRangeEndDateMonth sets the optional parameter "timeRange.endDate.month": // Month of a year. Must be from 1 to 12, or 0 to specify a year without a // month and day. -func (c *ProjectsLocationsGetConfigurablePricingUsageStatsCall) TimeRangeEndDateMonth(timeRangeEndDateMonth int64) *ProjectsLocationsGetConfigurablePricingUsageStatsCall { +func (c *ProjectsLocationsQueryConfigurablePricingUsageStatsCall) TimeRangeEndDateMonth(timeRangeEndDateMonth int64) *ProjectsLocationsQueryConfigurablePricingUsageStatsCall { c.urlParams_.Set("timeRange.endDate.month", fmt.Sprint(timeRangeEndDateMonth)) return c } @@ -36554,7 +35678,7 @@ func (c *ProjectsLocationsGetConfigurablePricingUsageStatsCall) TimeRangeEndDate // TimeRangeEndDateYear sets the optional parameter "timeRange.endDate.year": // Year of the date. Must be from 1 to 9999, or 0 to specify a date without a // year. -func (c *ProjectsLocationsGetConfigurablePricingUsageStatsCall) TimeRangeEndDateYear(timeRangeEndDateYear int64) *ProjectsLocationsGetConfigurablePricingUsageStatsCall { +func (c *ProjectsLocationsQueryConfigurablePricingUsageStatsCall) TimeRangeEndDateYear(timeRangeEndDateYear int64) *ProjectsLocationsQueryConfigurablePricingUsageStatsCall { c.urlParams_.Set("timeRange.endDate.year", fmt.Sprint(timeRangeEndDateYear)) return c } @@ -36563,7 +35687,7 @@ func (c *ProjectsLocationsGetConfigurablePricingUsageStatsCall) TimeRangeEndDate // 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. -func (c *ProjectsLocationsGetConfigurablePricingUsageStatsCall) TimeRangeStartDateDay(timeRangeStartDateDay int64) *ProjectsLocationsGetConfigurablePricingUsageStatsCall { +func (c *ProjectsLocationsQueryConfigurablePricingUsageStatsCall) TimeRangeStartDateDay(timeRangeStartDateDay int64) *ProjectsLocationsQueryConfigurablePricingUsageStatsCall { c.urlParams_.Set("timeRange.startDate.day", fmt.Sprint(timeRangeStartDateDay)) return c } @@ -36571,7 +35695,7 @@ func (c *ProjectsLocationsGetConfigurablePricingUsageStatsCall) TimeRangeStartDa // TimeRangeStartDateMonth sets the optional parameter // "timeRange.startDate.month": Month of a year. Must be from 1 to 12, or 0 to // specify a year without a month and day. -func (c *ProjectsLocationsGetConfigurablePricingUsageStatsCall) TimeRangeStartDateMonth(timeRangeStartDateMonth int64) *ProjectsLocationsGetConfigurablePricingUsageStatsCall { +func (c *ProjectsLocationsQueryConfigurablePricingUsageStatsCall) TimeRangeStartDateMonth(timeRangeStartDateMonth int64) *ProjectsLocationsQueryConfigurablePricingUsageStatsCall { c.urlParams_.Set("timeRange.startDate.month", fmt.Sprint(timeRangeStartDateMonth)) return c } @@ -36579,7 +35703,7 @@ func (c *ProjectsLocationsGetConfigurablePricingUsageStatsCall) TimeRangeStartDa // TimeRangeStartDateYear sets the optional parameter // "timeRange.startDate.year": Year of the date. Must be from 1 to 9999, or 0 // to specify a date without a year. -func (c *ProjectsLocationsGetConfigurablePricingUsageStatsCall) TimeRangeStartDateYear(timeRangeStartDateYear int64) *ProjectsLocationsGetConfigurablePricingUsageStatsCall { +func (c *ProjectsLocationsQueryConfigurablePricingUsageStatsCall) TimeRangeStartDateYear(timeRangeStartDateYear int64) *ProjectsLocationsQueryConfigurablePricingUsageStatsCall { c.urlParams_.Set("timeRange.startDate.year", fmt.Sprint(timeRangeStartDateYear)) return c } @@ -36587,7 +35711,7 @@ func (c *ProjectsLocationsGetConfigurablePricingUsageStatsCall) TimeRangeStartDa // Fields allows partial responses to be retrieved. See // https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more // details. -func (c *ProjectsLocationsGetConfigurablePricingUsageStatsCall) Fields(s ...googleapi.Field) *ProjectsLocationsGetConfigurablePricingUsageStatsCall { +func (c *ProjectsLocationsQueryConfigurablePricingUsageStatsCall) Fields(s ...googleapi.Field) *ProjectsLocationsQueryConfigurablePricingUsageStatsCall { c.urlParams_.Set("fields", googleapi.CombineFields(s)) return c } @@ -36595,34 +35719,34 @@ func (c *ProjectsLocationsGetConfigurablePricingUsageStatsCall) Fields(s ...goog // IfNoneMatch sets an optional parameter which makes the operation fail if the // object's ETag matches the given value. This is useful for getting updates // only after the object has changed since the last request. -func (c *ProjectsLocationsGetConfigurablePricingUsageStatsCall) IfNoneMatch(entityTag string) *ProjectsLocationsGetConfigurablePricingUsageStatsCall { +func (c *ProjectsLocationsQueryConfigurablePricingUsageStatsCall) IfNoneMatch(entityTag string) *ProjectsLocationsQueryConfigurablePricingUsageStatsCall { c.ifNoneMatch_ = entityTag return c } // Context sets the context to be used in this call's Do method. -func (c *ProjectsLocationsGetConfigurablePricingUsageStatsCall) Context(ctx context.Context) *ProjectsLocationsGetConfigurablePricingUsageStatsCall { +func (c *ProjectsLocationsQueryConfigurablePricingUsageStatsCall) Context(ctx context.Context) *ProjectsLocationsQueryConfigurablePricingUsageStatsCall { c.ctx_ = ctx return c } // Header returns a http.Header that can be modified by the caller to add // headers to the request. -func (c *ProjectsLocationsGetConfigurablePricingUsageStatsCall) Header() http.Header { +func (c *ProjectsLocationsQueryConfigurablePricingUsageStatsCall) Header() http.Header { if c.header_ == nil { c.header_ = make(http.Header) } return c.header_ } -func (c *ProjectsLocationsGetConfigurablePricingUsageStatsCall) doRequest(alt string) (*http.Response, error) { +func (c *ProjectsLocationsQueryConfigurablePricingUsageStatsCall) doRequest(alt string) (*http.Response, error) { reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_) if c.ifNoneMatch_ != "" { reqHeaders.Set("If-None-Match", c.ifNoneMatch_) } c.urlParams_.Set("alt", alt) c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "v1alpha/{+name}") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1alpha/{+project}/locations/{location}:queryConfigurablePricingUsageStats") urls += "?" + c.urlParams_.Encode() req, err := http.NewRequest("GET", urls, nil) if err != nil { @@ -36630,129 +35754,20 @@ func (c *ProjectsLocationsGetConfigurablePricingUsageStatsCall) doRequest(alt st } req.Header = reqHeaders googleapi.Expand(req.URL, map[string]string{ - "name": c.name, - }) - c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.getConfigurablePricingUsageStats", "request", internallog.HTTPRequest(req, nil)) - return gensupport.SendRequest(c.ctx_, c.s.client, req) -} - -// Do executes the "discoveryengine.projects.locations.getConfigurablePricingUsageStats" call. -// Any non-2xx status code is an error. Response headers are in either -// *GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStats.ServerRespons -// e.Header or (if a response was returned at all) in -// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check -// whether the returned error was because http.StatusNotModified was returned. -func (c *ProjectsLocationsGetConfigurablePricingUsageStatsCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStats, error) { - gensupport.SetOptions(c.urlParams_, opts...) - res, err := c.doRequest("json") - if res != nil && res.StatusCode == http.StatusNotModified { - if res.Body != nil { - res.Body.Close() - } - return nil, gensupport.WrapError(&googleapi.Error{ - Code: res.StatusCode, - Header: res.Header, - }) - } - if err != nil { - return nil, err - } - defer googleapi.CloseBody(res) - if err := googleapi.CheckResponse(res); err != nil { - return nil, gensupport.WrapError(err) - } - ret := &GoogleCloudDiscoveryengineV1alphaConfigurablePricingUsageStats{ - ServerResponse: googleapi.ServerResponse{ - Header: res.Header, - HTTPStatusCode: res.StatusCode, - }, - } - target := &ret - b, err := gensupport.DecodeResponseBytes(target, res) - if err != nil { - return nil, err - } - c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.getConfigurablePricingUsageStats", "response", internallog.HTTPResponse(res, b)) - return ret, nil -} - -type ProjectsLocationsObtainCrawlRateCall struct { - s *Service - location string - googleclouddiscoveryenginev1alphaobtaincrawlraterequest *GoogleCloudDiscoveryengineV1alphaObtainCrawlRateRequest - urlParams_ gensupport.URLParams - ctx_ context.Context - header_ http.Header -} - -// ObtainCrawlRate: Obtains the time series data of organic or dedicated crawl -// rate for monitoring. When dedicated crawl rate is not set, it will return -// vertex AI's organic crawl rate time series. Organic crawl means Google -// automatically crawl the internet at its own convenience. When dedicated -// crawl rate is set, it will return vertex AI's dedicated crawl rate time -// series. -// -// - location: The location resource where crawl rate management will be -// performed. Format: `projects/{project}/locations/{location}`. -func (r *ProjectsLocationsService) ObtainCrawlRate(location string, googleclouddiscoveryenginev1alphaobtaincrawlraterequest *GoogleCloudDiscoveryengineV1alphaObtainCrawlRateRequest) *ProjectsLocationsObtainCrawlRateCall { - c := &ProjectsLocationsObtainCrawlRateCall{s: r.s, urlParams_: make(gensupport.URLParams)} - c.location = location - c.googleclouddiscoveryenginev1alphaobtaincrawlraterequest = googleclouddiscoveryenginev1alphaobtaincrawlraterequest - return c -} - -// Fields allows partial responses to be retrieved. See -// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more -// details. -func (c *ProjectsLocationsObtainCrawlRateCall) Fields(s ...googleapi.Field) *ProjectsLocationsObtainCrawlRateCall { - c.urlParams_.Set("fields", googleapi.CombineFields(s)) - return c -} - -// Context sets the context to be used in this call's Do method. -func (c *ProjectsLocationsObtainCrawlRateCall) Context(ctx context.Context) *ProjectsLocationsObtainCrawlRateCall { - c.ctx_ = ctx - return c -} - -// Header returns a http.Header that can be modified by the caller to add -// headers to the request. -func (c *ProjectsLocationsObtainCrawlRateCall) Header() http.Header { - if c.header_ == nil { - c.header_ = make(http.Header) - } - return c.header_ -} - -func (c *ProjectsLocationsObtainCrawlRateCall) doRequest(alt string) (*http.Response, error) { - reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "application/json", c.header_) - body, err := googleapi.WithoutDataWrapper.JSONBuffer(c.googleclouddiscoveryenginev1alphaobtaincrawlraterequest) - if err != nil { - return nil, err - } - c.urlParams_.Set("alt", alt) - c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "v1alpha/{+location}:obtainCrawlRate") - urls += "?" + c.urlParams_.Encode() - req, err := http.NewRequest("POST", urls, body) - if err != nil { - return nil, err - } - req.Header = reqHeaders - googleapi.Expand(req.URL, map[string]string{ + "project": c.project, "location": c.location, }) - c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.obtainCrawlRate", "request", internallog.HTTPRequest(req, body.Bytes())) + c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.queryConfigurablePricingUsageStats", "request", internallog.HTTPRequest(req, nil)) return gensupport.SendRequest(c.ctx_, c.s.client, req) } -// Do executes the "discoveryengine.projects.locations.obtainCrawlRate" call. +// Do executes the "discoveryengine.projects.locations.queryConfigurablePricingUsageStats" call. // Any non-2xx status code is an error. Response headers are in either -// *GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse.ServerResponse.Head -// er or (if a response was returned at all) in +// *GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponse. +// ServerResponse.Header or (if a response was returned at all) in // error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check // whether the returned error was because http.StatusNotModified was returned. -func (c *ProjectsLocationsObtainCrawlRateCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse, error) { +func (c *ProjectsLocationsQueryConfigurablePricingUsageStatsCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponse, error) { gensupport.SetOptions(c.urlParams_, opts...) res, err := c.doRequest("json") if res != nil && res.StatusCode == http.StatusNotModified { @@ -36771,7 +35786,7 @@ func (c *ProjectsLocationsObtainCrawlRateCall) Do(opts ...googleapi.CallOption) if err := googleapi.CheckResponse(res); err != nil { return nil, gensupport.WrapError(err) } - ret := &GoogleCloudDiscoveryengineV1alphaObtainCrawlRateResponse{ + ret := &GoogleCloudDiscoveryengineV1alphaQueryConfigurablePricingUsageStatsResponse{ ServerResponse: googleapi.ServerResponse{ Header: res.Header, HTTPStatusCode: res.StatusCode, @@ -36782,7 +35797,7 @@ func (c *ProjectsLocationsObtainCrawlRateCall) Do(opts ...googleapi.CallOption) if err != nil { return nil, err } - c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.obtainCrawlRate", "response", internallog.HTTPResponse(res, b)) + c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.queryConfigurablePricingUsageStats", "response", internallog.HTTPResponse(res, b)) return ret, nil } @@ -39965,9 +38980,9 @@ func (c *ProjectsLocationsCollectionsDataConnectorOperationsListCall) PageToken( // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsCollectionsDataConnectorOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsCollectionsDataConnectorOperationsListCall { @@ -43279,9 +42294,9 @@ func (c *ProjectsLocationsCollectionsDataStoresBranchesOperationsListCall) PageT // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsCollectionsDataStoresBranchesOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsCollectionsDataStoresBranchesOperationsListCall { @@ -45307,9 +44322,9 @@ func (c *ProjectsLocationsCollectionsDataStoresModelsOperationsListCall) PageTok // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsCollectionsDataStoresModelsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsCollectionsDataStoresModelsOperationsListCall { @@ -45584,9 +44599,9 @@ func (c *ProjectsLocationsCollectionsDataStoresOperationsListCall) PageToken(pag // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsCollectionsDataStoresOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsCollectionsDataStoresOperationsListCall { @@ -46454,9 +45469,9 @@ func (c *ProjectsLocationsCollectionsDataStoresSchemasOperationsListCall) PageTo // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsCollectionsDataStoresSchemasOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsCollectionsDataStoresSchemasOperationsListCall { @@ -49233,9 +48248,9 @@ func (c *ProjectsLocationsCollectionsDataStoresSiteSearchEngineOperationsListCal // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsCollectionsDataStoresSiteSearchEngineOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsCollectionsDataStoresSiteSearchEngineOperationsListCall { @@ -50530,9 +49545,9 @@ func (c *ProjectsLocationsCollectionsDataStoresSiteSearchEngineTargetSitesOperat // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsCollectionsDataStoresSiteSearchEngineTargetSitesOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsCollectionsDataStoresSiteSearchEngineTargetSitesOperationsListCall { @@ -52730,6 +51745,224 @@ func (c *ProjectsLocationsCollectionsEnginesAnalyticsExportMetricsCall) Do(opts return ret, nil } +type ProjectsLocationsCollectionsEnginesAssistantsCreateCall struct { + s *Service + parent string + googleclouddiscoveryenginev1alphaassistant *GoogleCloudDiscoveryengineV1alphaAssistant + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// Create: Creates an Assistant. +// +// - parent: The parent resource name. Format: +// `projects/{project}/locations/{location}/collections/{collection}/engines/{ +// engine}`. +func (r *ProjectsLocationsCollectionsEnginesAssistantsService) Create(parent string, googleclouddiscoveryenginev1alphaassistant *GoogleCloudDiscoveryengineV1alphaAssistant) *ProjectsLocationsCollectionsEnginesAssistantsCreateCall { + c := &ProjectsLocationsCollectionsEnginesAssistantsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.parent = parent + c.googleclouddiscoveryenginev1alphaassistant = googleclouddiscoveryenginev1alphaassistant + return c +} + +// AssistantId sets the optional parameter "assistantId": Required. The ID to +// use for the Assistant, which will become the final component of the +// Assistant's resource name. This field must conform to RFC-1034 +// (https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters. +func (c *ProjectsLocationsCollectionsEnginesAssistantsCreateCall) AssistantId(assistantId string) *ProjectsLocationsCollectionsEnginesAssistantsCreateCall { + c.urlParams_.Set("assistantId", assistantId) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more +// details. +func (c *ProjectsLocationsCollectionsEnginesAssistantsCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsCollectionsEnginesAssistantsCreateCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. +func (c *ProjectsLocationsCollectionsEnginesAssistantsCreateCall) Context(ctx context.Context) *ProjectsLocationsCollectionsEnginesAssistantsCreateCall { + c.ctx_ = ctx + return c +} + +// Header returns a http.Header that can be modified by the caller to add +// headers to the request. +func (c *ProjectsLocationsCollectionsEnginesAssistantsCreateCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsCollectionsEnginesAssistantsCreateCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "application/json", c.header_) + body, err := googleapi.WithoutDataWrapper.JSONBuffer(c.googleclouddiscoveryenginev1alphaassistant) + if err != nil { + return nil, err + } + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1alpha/{+parent}/assistants") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "parent": c.parent, + }) + c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.collections.engines.assistants.create", "request", internallog.HTTPRequest(req, body.Bytes())) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "discoveryengine.projects.locations.collections.engines.assistants.create" call. +// Any non-2xx status code is an error. Response headers are in either +// *GoogleCloudDiscoveryengineV1alphaAssistant.ServerResponse.Header or (if a +// response was returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsLocationsCollectionsEnginesAssistantsCreateCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDiscoveryengineV1alphaAssistant, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleCloudDiscoveryengineV1alphaAssistant{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + b, err := gensupport.DecodeResponseBytes(target, res) + if err != nil { + return nil, err + } + c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.collections.engines.assistants.create", "response", internallog.HTTPResponse(res, b)) + return ret, nil +} + +type ProjectsLocationsCollectionsEnginesAssistantsDeleteCall struct { + s *Service + name string + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// Delete: Deletes an Assistant. +// +// - name: Resource name of Assistant. Format: +// `projects/{project}/locations/{location}/collections/{collection}/engines/{ +// engine}/assistants/{assistant}` If the caller does not have permission to +// delete the Assistant, regardless of whether or not it exists, a +// PERMISSION_DENIED error is returned. If the Assistant to delete does not +// exist, a NOT_FOUND error is returned. +func (r *ProjectsLocationsCollectionsEnginesAssistantsService) Delete(name string) *ProjectsLocationsCollectionsEnginesAssistantsDeleteCall { + c := &ProjectsLocationsCollectionsEnginesAssistantsDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more +// details. +func (c *ProjectsLocationsCollectionsEnginesAssistantsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsCollectionsEnginesAssistantsDeleteCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. +func (c *ProjectsLocationsCollectionsEnginesAssistantsDeleteCall) Context(ctx context.Context) *ProjectsLocationsCollectionsEnginesAssistantsDeleteCall { + c.ctx_ = ctx + return c +} + +// Header returns a http.Header that can be modified by the caller to add +// headers to the request. +func (c *ProjectsLocationsCollectionsEnginesAssistantsDeleteCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsCollectionsEnginesAssistantsDeleteCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_) + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1alpha/{+name}") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("DELETE", urls, nil) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.collections.engines.assistants.delete", "request", internallog.HTTPRequest(req, nil)) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "discoveryengine.projects.locations.collections.engines.assistants.delete" call. +// Any non-2xx status code is an error. Response headers are in either +// *GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned at +// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to +// check whether the returned error was because http.StatusNotModified was +// returned. +func (c *ProjectsLocationsCollectionsEnginesAssistantsDeleteCall) Do(opts ...googleapi.CallOption) (*GoogleProtobufEmpty, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleProtobufEmpty{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + b, err := gensupport.DecodeResponseBytes(target, res) + if err != nil { + return nil, err + } + c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.collections.engines.assistants.delete", "response", internallog.HTTPResponse(res, b)) + return ret, nil +} + type ProjectsLocationsCollectionsEnginesAssistantsGetCall struct { s *Service name string @@ -52842,6 +52075,157 @@ func (c *ProjectsLocationsCollectionsEnginesAssistantsGetCall) Do(opts ...google return ret, nil } +type ProjectsLocationsCollectionsEnginesAssistantsListCall struct { + s *Service + parent string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// List: Lists all Assistants under an Engine. +// +// - parent: The parent resource name. Format: +// `projects/{project}/locations/{location}/collections/{collection}/engines/{ +// engine}`. +func (r *ProjectsLocationsCollectionsEnginesAssistantsService) List(parent string) *ProjectsLocationsCollectionsEnginesAssistantsListCall { + c := &ProjectsLocationsCollectionsEnginesAssistantsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.parent = parent + return c +} + +// PageSize sets the optional parameter "pageSize": Maximum number of +// Assistants to return. If unspecified, defaults to 100. The maximum allowed +// value is 1000; anything above that will be coerced down to 1000. +func (c *ProjectsLocationsCollectionsEnginesAssistantsListCall) PageSize(pageSize int64) *ProjectsLocationsCollectionsEnginesAssistantsListCall { + c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) + return c +} + +// PageToken sets the optional parameter "pageToken": A page token +// ListAssistantsResponse.next_page_token, received from a previous +// AssistantService.ListAssistants call. Provide this to retrieve the +// subsequent page. When paginating, all other parameters provided to +// ListAssistants must match the call that provided the page token. +func (c *ProjectsLocationsCollectionsEnginesAssistantsListCall) PageToken(pageToken string) *ProjectsLocationsCollectionsEnginesAssistantsListCall { + c.urlParams_.Set("pageToken", pageToken) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more +// details. +func (c *ProjectsLocationsCollectionsEnginesAssistantsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsCollectionsEnginesAssistantsListCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets an optional parameter which makes the operation fail if the +// object's ETag matches the given value. This is useful for getting updates +// only after the object has changed since the last request. +func (c *ProjectsLocationsCollectionsEnginesAssistantsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsCollectionsEnginesAssistantsListCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. +func (c *ProjectsLocationsCollectionsEnginesAssistantsListCall) Context(ctx context.Context) *ProjectsLocationsCollectionsEnginesAssistantsListCall { + c.ctx_ = ctx + return c +} + +// Header returns a http.Header that can be modified by the caller to add +// headers to the request. +func (c *ProjectsLocationsCollectionsEnginesAssistantsListCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsCollectionsEnginesAssistantsListCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1alpha/{+parent}/assistants") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, nil) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "parent": c.parent, + }) + c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.collections.engines.assistants.list", "request", internallog.HTTPRequest(req, nil)) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "discoveryengine.projects.locations.collections.engines.assistants.list" call. +// Any non-2xx status code is an error. Response headers are in either +// *GoogleCloudDiscoveryengineV1alphaListAssistantsResponse.ServerResponse.Heade +// r or (if a response was returned at all) in error.(*googleapi.Error).Header. +// Use googleapi.IsNotModified to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsLocationsCollectionsEnginesAssistantsListCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDiscoveryengineV1alphaListAssistantsResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleCloudDiscoveryengineV1alphaListAssistantsResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + b, err := gensupport.DecodeResponseBytes(target, res) + if err != nil { + return nil, err + } + c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.collections.engines.assistants.list", "response", internallog.HTTPResponse(res, b)) + return ret, nil +} + +// Pages invokes f for each page of results. +// A non-nil error returned from f will halt the iteration. +// The provided context supersedes any context provided to the Context method. +func (c *ProjectsLocationsCollectionsEnginesAssistantsListCall) Pages(ctx context.Context, f func(*GoogleCloudDiscoveryengineV1alphaListAssistantsResponse) error) error { + c.ctx_ = ctx + defer c.PageToken(c.urlParams_.Get("pageToken")) + for { + x, err := c.Do() + if err != nil { + return err + } + if err := f(x); err != nil { + return err + } + if x.NextPageToken == "" { + return nil + } + c.PageToken(x.NextPageToken) + } +} + type ProjectsLocationsCollectionsEnginesAssistantsListAvailableAgentViewsCall struct { s *Service parent string @@ -54638,6 +54022,118 @@ func (c *ProjectsLocationsCollectionsEnginesAssistantsAgentsFilesImportCall) Do( return ret, nil } +type ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall struct { + s *Service + name string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// 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. +// +// - name: The name of the operation resource. +func (r *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsService) Get(name string) *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall { + c := &ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more +// details. +func (c *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets an optional parameter which makes the operation fail if the +// object's ETag matches the given value. This is useful for getting updates +// only after the object has changed since the last request. +func (c *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. +func (c *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall { + c.ctx_ = ctx + return c +} + +// Header returns a http.Header that can be modified by the caller to add +// headers to the request. +func (c *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1alpha/{+name}") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, nil) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.collections.engines.assistants.agents.operations.get", "request", internallog.HTTPRequest(req, nil)) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "discoveryengine.projects.locations.collections.engines.assistants.agents.operations.get" call. +// Any non-2xx status code is an error. Response headers are in either +// *GoogleLongrunningOperation.ServerResponse.Header or (if a response was +// returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleLongrunningOperation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + b, err := gensupport.DecodeResponseBytes(target, res) + if err != nil { + return nil, err + } + c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.collections.engines.assistants.agents.operations.get", "response", internallog.HTTPResponse(res, b)) + return ret, nil +} + type ProjectsLocationsCollectionsEnginesAssistantsCannedQueriesCreateCall struct { s *Service parent string @@ -56932,9 +56428,9 @@ func (c *ProjectsLocationsCollectionsEnginesOperationsListCall) PageToken(pageTo // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsCollectionsEnginesOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsCollectionsEnginesOperationsListCall { @@ -59345,9 +58841,9 @@ func (c *ProjectsLocationsCollectionsOperationsListCall) PageToken(pageToken str // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsCollectionsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsCollectionsOperationsListCall { @@ -62552,9 +62048,9 @@ func (c *ProjectsLocationsDataStoresBranchesOperationsListCall) PageToken(pageTo // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsDataStoresBranchesOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsDataStoresBranchesOperationsListCall { @@ -64467,9 +63963,9 @@ func (c *ProjectsLocationsDataStoresModelsOperationsListCall) PageToken(pageToke // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsDataStoresModelsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsDataStoresModelsOperationsListCall { @@ -64744,9 +64240,9 @@ func (c *ProjectsLocationsDataStoresOperationsListCall) PageToken(pageToken stri // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsDataStoresOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsDataStoresOperationsListCall { @@ -71200,9 +70696,9 @@ func (c *ProjectsLocationsIdentityMappingStoresOperationsListCall) PageToken(pag // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsIdentityMappingStoresOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsIdentityMappingStoresOperationsListCall { @@ -72767,116 +72263,6 @@ func (c *ProjectsLocationsNotebooksSourcesGetCall) Do(opts ...googleapi.CallOpti return ret, nil } -type ProjectsLocationsNotebooksSourcesUploadFileCall struct { - s *Service - parent string - sourceId string - googlecloudnotebooklmv1alphauploadsourcefilerequest *GoogleCloudNotebooklmV1alphaUploadSourceFileRequest - urlParams_ gensupport.URLParams - ctx_ context.Context - header_ http.Header -} - -// UploadFile: Uploads a file for Notebook LM to use. Creates a Source. -// -// - parent: The parent resource where the sources will be created. Format: -// projects/{project}/locations/{location}/notebooks/{notebook}. -// - sourceId: The source id of the associated file. If not set, a source id -// will be generated and a new tentative source will be created. -func (r *ProjectsLocationsNotebooksSourcesService) UploadFile(parent string, sourceId string, googlecloudnotebooklmv1alphauploadsourcefilerequest *GoogleCloudNotebooklmV1alphaUploadSourceFileRequest) *ProjectsLocationsNotebooksSourcesUploadFileCall { - c := &ProjectsLocationsNotebooksSourcesUploadFileCall{s: r.s, urlParams_: make(gensupport.URLParams)} - c.parent = parent - c.sourceId = sourceId - c.googlecloudnotebooklmv1alphauploadsourcefilerequest = googlecloudnotebooklmv1alphauploadsourcefilerequest - return c -} - -// Fields allows partial responses to be retrieved. See -// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more -// details. -func (c *ProjectsLocationsNotebooksSourcesUploadFileCall) Fields(s ...googleapi.Field) *ProjectsLocationsNotebooksSourcesUploadFileCall { - c.urlParams_.Set("fields", googleapi.CombineFields(s)) - return c -} - -// Context sets the context to be used in this call's Do method. -func (c *ProjectsLocationsNotebooksSourcesUploadFileCall) Context(ctx context.Context) *ProjectsLocationsNotebooksSourcesUploadFileCall { - c.ctx_ = ctx - return c -} - -// Header returns a http.Header that can be modified by the caller to add -// headers to the request. -func (c *ProjectsLocationsNotebooksSourcesUploadFileCall) Header() http.Header { - if c.header_ == nil { - c.header_ = make(http.Header) - } - return c.header_ -} - -func (c *ProjectsLocationsNotebooksSourcesUploadFileCall) doRequest(alt string) (*http.Response, error) { - reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "application/json", c.header_) - body, err := googleapi.WithoutDataWrapper.JSONBuffer(c.googlecloudnotebooklmv1alphauploadsourcefilerequest) - if err != nil { - return nil, err - } - c.urlParams_.Set("alt", alt) - c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "v1alpha/{+parent}/sources/{sourceId}:uploadFile") - urls += "?" + c.urlParams_.Encode() - req, err := http.NewRequest("POST", urls, body) - if err != nil { - return nil, err - } - req.Header = reqHeaders - googleapi.Expand(req.URL, map[string]string{ - "parent": c.parent, - "sourceId": c.sourceId, - }) - c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.notebooks.sources.uploadFile", "request", internallog.HTTPRequest(req, body.Bytes())) - return gensupport.SendRequest(c.ctx_, c.s.client, req) -} - -// Do executes the "discoveryengine.projects.locations.notebooks.sources.uploadFile" call. -// Any non-2xx status code is an error. Response headers are in either -// *GoogleCloudNotebooklmV1alphaUploadSourceFileResponse.ServerResponse.Header -// or (if a response was returned at all) in error.(*googleapi.Error).Header. -// Use googleapi.IsNotModified to check whether the returned error was because -// http.StatusNotModified was returned. -func (c *ProjectsLocationsNotebooksSourcesUploadFileCall) Do(opts ...googleapi.CallOption) (*GoogleCloudNotebooklmV1alphaUploadSourceFileResponse, error) { - gensupport.SetOptions(c.urlParams_, opts...) - res, err := c.doRequest("json") - if res != nil && res.StatusCode == http.StatusNotModified { - if res.Body != nil { - res.Body.Close() - } - return nil, gensupport.WrapError(&googleapi.Error{ - Code: res.StatusCode, - Header: res.Header, - }) - } - if err != nil { - return nil, err - } - defer googleapi.CloseBody(res) - if err := googleapi.CheckResponse(res); err != nil { - return nil, gensupport.WrapError(err) - } - ret := &GoogleCloudNotebooklmV1alphaUploadSourceFileResponse{ - ServerResponse: googleapi.ServerResponse{ - Header: res.Header, - HTTPStatusCode: res.StatusCode, - }, - } - target := &ret - b, err := gensupport.DecodeResponseBytes(target, res) - if err != nil { - return nil, err - } - c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.notebooks.sources.uploadFile", "response", internallog.HTTPResponse(res, b)) - return ret, nil -} - type ProjectsLocationsOperationsGetCall struct { s *Service name string @@ -73031,9 +72417,9 @@ func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *Proje // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsOperationsListCall { @@ -76093,9 +75479,9 @@ func (c *ProjectsLocationsUserStoresOperationsListCall) PageToken(pageToken stri // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsUserStoresOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsUserStoresOperationsListCall { @@ -76235,16 +75621,22 @@ func (r *ProjectsLocationsUserStoresUserLicensesService) List(parent string) *Pr return c } -// Filter sets the optional parameter "filter": Filter for the list request. -// Supported fields: * `license`_`assignment`_`state` * `user_principal` * -// `user_profile` Examples: * `license`_`assignment`_`state = ASSIGNED` to list -// assigned user licenses. * `license`_`assignment`_`state = NO_LICENSE` to -// list not licensed users. * `license`_`assignment`_`state = -// NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license -// assigned. * `license`_`assignment`_`state != NO_LICENSE_ATTEMPTED_LOGIN` to -// filter out users who attempted login but no license assigned. -func (c *ProjectsLocationsUserStoresUserLicensesListCall) Filter(filter string) *ProjectsLocationsUserStoresUserLicensesListCall { - c.urlParams_.Set("filter", filter) +// OrderBy sets the optional parameter "orderBy": The order in which the +// UserLicenses are listed. The value must be a comma-separated list of fields. +// Default sorting order is ascending. To specify descending order for a field, +// append a " desc" suffix. Redundant space characters in the syntax are +// insignificant. Supported fields: * `license_assignment_state` * +// `user_principal` * `user_profile` * `last_login_date` * `update_time` If not +// set, the default ordering is by `user_principal`. Examples: * +// `user_principal desc` to order by `user_principal` in descending order. * +// `license_assignment_state` to order by `license_assignment_state` in +// ascending order. * `last_login_date desc` to order by `last_login_date` in +// descending order. * `update_time desc` to order by `update_time` in +// descending order. * `last_login_date desc, user_principal` to order by +// `last_login_date` in descending order and then by `user_principal` in +// ascending order. +func (c *ProjectsLocationsUserStoresUserLicensesListCall) OrderBy(orderBy string) *ProjectsLocationsUserStoresUserLicensesListCall { + c.urlParams_.Set("orderBy", orderBy) return c } @@ -76533,9 +75925,9 @@ func (c *ProjectsOperationsListCall) PageToken(pageToken string) *ProjectsOperat // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsOperationsListCall { diff --git a/discoveryengine/v1beta/discoveryengine-api.json b/discoveryengine/v1beta/discoveryengine-api.json index 2d5103569c6..e4b0daf75af 100644 --- a/discoveryengine/v1beta/discoveryengine-api.json +++ b/discoveryengine/v1beta/discoveryengine-api.json @@ -141,49 +141,6 @@ }, "protocol": "rest", "resources": { - "media": { - "methods": { - "download": { - "description": "Downloads a file from the session.", - "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/sessions/{sessionsId}:downloadFile", - "httpMethod": "GET", - "id": "discoveryengine.media.download", - "parameterOrder": [ - "name" - ], - "parameters": { - "fileId": { - "description": "Required. The ID of the file to be downloaded.", - "location": "query", - "type": "string" - }, - "name": { - "description": "Required. The resource name of the Session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", - "required": true, - "type": "string" - }, - "viewId": { - "description": "Optional. The ID of the view to be downloaded.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta/{+name}:downloadFile", - "response": { - "$ref": "GdataMedia" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", - "https://www.googleapis.com/auth/discoveryengine.readwrite" - ], - "supportsMediaDownload": true, - "useMediaDownloadService": true - } - } - }, "projects": { "methods": { "provision": { @@ -604,7 +561,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -1268,7 +1225,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -1841,7 +1798,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -1920,7 +1877,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -2158,7 +2115,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -2852,7 +2809,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -3200,7 +3157,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -3684,6 +3641,68 @@ "resources": { "assistants": { "methods": { + "create": { + "description": "Creates an Assistant.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.collections.engines.assistants.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "assistantId": { + "description": "Required. The ID to use for the Assistant, which will become the final component of the Assistant's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/assistants", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaAssistant" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaAssistant" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, + "delete": { + "description": "Deletes an Assistant.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}", + "httpMethod": "DELETE", + "id": "discoveryengine.projects.locations.collections.engines.assistants.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` If the caller does not have permission to delete the Assistant, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Assistant to delete does not exist, a NOT_FOUND error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, "get": { "description": "Gets an Assistant.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}", @@ -3711,6 +3730,44 @@ "https://www.googleapis.com/auth/discoveryengine.readwrite" ] }, + "list": { + "description": "Lists all Assistants under an Engine.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.engines.assistants.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of Assistants to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token ListAssistantsResponse.next_page_token, received from a previous AssistantService.ListAssistants call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAssistants must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/assistants", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaListAssistantsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.assist.readwrite", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + }, "patch": { "description": "Updates an Assistant", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}", @@ -3777,6 +3834,42 @@ "https://www.googleapis.com/auth/discoveryengine.readwrite" ] } + }, + "resources": { + "agents": { + "resources": { + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/assistants/{assistantsId}/agents/{agentsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.engines.assistants.agents.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/assistants/[^/]+/agents/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/discoveryengine.readwrite" + ] + } + } + } + } + } } }, "completionConfig": { @@ -4268,7 +4361,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -4805,7 +4898,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -5440,7 +5533,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -5983,7 +6076,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -6062,7 +6155,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -7760,7 +7853,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -7938,7 +8031,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -8713,8 +8806,8 @@ "parent" ], "parameters": { - "filter": { - "description": "Optional. Filter for the list request. Supported fields: * `license`_`assignment`_`state` * `user_principal` * `user_profile` Examples: * `license`_`assignment`_`state = ASSIGNED` to list assigned user licenses. * `license`_`assignment`_`state = NO_LICENSE` to list not licensed users. * `license`_`assignment`_`state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license`_`assignment`_`state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned.", + "orderBy": { + "description": "Optional. The order in which the UserLicenses are listed. The value must be a comma-separated list of fields. Default sorting order is ascending. To specify descending order for a field, append a \" desc\" suffix. Redundant space characters in the syntax are insignificant. Supported fields: * `license_assignment_state` * `user_principal` * `user_profile` * `last_login_date` * `update_time` If not set, the default ordering is by `user_principal`. Examples: * `user_principal desc` to order by `user_principal` in descending order. * `license_assignment_state` to order by `license_assignment_state` in ascending order. * `last_login_date desc` to order by `last_login_date` in descending order. * `update_time desc` to order by `update_time` in descending order. * `last_login_date desc, user_principal` to order by `last_login_date` in descending order and then by `user_principal` in ascending order.", "location": "query", "type": "string" }, @@ -8813,7 +8906,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -8832,439 +8925,9 @@ } } }, - "revision": "20251109", + "revision": "20251116", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { - "GdataBlobstore2Info": { - "description": "Information to read/write to blobstore2.", - "id": "GdataBlobstore2Info", - "properties": { - "blobGeneration": { - "description": "The blob generation id.", - "format": "int64", - "type": "string" - }, - "blobId": { - "description": "The blob id, e.g., /blobstore/prod/playground/scotty", - "type": "string" - }, - "downloadReadHandle": { - "description": "Read handle passed from Bigstore -\u003e Scotty for a GCS download. This is a signed, serialized blobstore2.ReadHandle proto which must never be set outside of Bigstore, and is not applicable to non-GCS media downloads.", - "format": "byte", - "type": "string" - }, - "readToken": { - "description": "The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.", - "type": "string" - }, - "uploadMetadataContainer": { - "description": "Metadata passed from Blobstore -\u003e Scotty for a new GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer proto which must never be consumed outside of Bigstore, and is not applicable to non-GCS media uploads.", - "format": "byte", - "type": "string" - } - }, - "type": "object" - }, - "GdataCompositeMedia": { - "description": "A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites.", - "id": "GdataCompositeMedia", - "properties": { - "blobRef": { - "deprecated": true, - "description": "Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.", - "format": "byte", - "type": "string" - }, - "blobstore2Info": { - "$ref": "GdataBlobstore2Info", - "description": "Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob." - }, - "cosmoBinaryReference": { - "description": "A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.", - "format": "byte", - "type": "string" - }, - "crc32cHash": { - "description": "crc32.c hash for the payload.", - "format": "uint32", - "type": "integer" - }, - "inline": { - "description": "Media data, set if reference_type is INLINE", - "format": "byte", - "type": "string" - }, - "length": { - "description": "Size of the data, in bytes", - "format": "int64", - "type": "string" - }, - "md5Hash": { - "description": "MD5 hash for the payload.", - "format": "byte", - "type": "string" - }, - "objectId": { - "$ref": "GdataObjectId", - "description": "Reference to a TI Blob, set if reference_type is BIGSTORE_REF." - }, - "path": { - "description": "Path to the data, set if reference_type is PATH", - "type": "string" - }, - "referenceType": { - "description": "Describes what the field reference contains.", - "enum": [ - "PATH", - "BLOB_REF", - "INLINE", - "BIGSTORE_REF", - "COSMO_BINARY_REFERENCE" - ], - "enumDescriptions": [ - "Reference contains a GFS path or a local path.", - "Reference points to a blobstore object. This could be either a v1 blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info first, since v1 is being deprecated.", - "Data is included into this proto buffer", - "Reference points to a bigstore object", - "Indicates the data is stored in cosmo_binary_reference." - ], - "type": "string" - }, - "sha1Hash": { - "description": "SHA-1 hash for the payload.", - "format": "byte", - "type": "string" - } - }, - "type": "object" - }, - "GdataContentTypeInfo": { - "description": "Detailed Content-Type information from Scotty. The Content-Type of the media will typically be filled in by the header or Scotty's best_guess, but this extended information provides the backend with more information so that it can make a better decision if needed. This is only used on media upload requests from Scotty.", - "id": "GdataContentTypeInfo", - "properties": { - "bestGuess": { - "description": "Scotty's best guess of what the content type of the file is.", - "type": "string" - }, - "fromBytes": { - "description": "The content type of the file derived by looking at specific bytes (i.e. \"magic bytes\") of the actual file.", - "type": "string" - }, - "fromFileName": { - "description": "The content type of the file derived from the file extension of the original file name used by the client.", - "type": "string" - }, - "fromHeader": { - "description": "The content type of the file as specified in the request headers, multipart headers, or RUPIO start request.", - "type": "string" - }, - "fromUrlPath": { - "description": "The content type of the file derived from the file extension of the URL path. The URL path is assumed to represent a file name (which is typically only true for agents that are providing a REST API).", - "type": "string" - } - }, - "type": "object" - }, - "GdataDiffChecksumsResponse": { - "description": "Backend response for a Diff get checksums response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.", - "id": "GdataDiffChecksumsResponse", - "properties": { - "checksumsLocation": { - "$ref": "GdataCompositeMedia", - "description": "Exactly one of these fields must be populated. If checksums_location is filled, the server will return the corresponding contents to the user. If object_location is filled, the server will calculate the checksums based on the content there and return that to the user. For details on the format of the checksums, see http://go/scotty-diff-protocol." - }, - "chunkSizeBytes": { - "description": "The chunk size of checksums. Must be a multiple of 256KB.", - "format": "int64", - "type": "string" - }, - "objectLocation": { - "$ref": "GdataCompositeMedia", - "description": "If set, calculate the checksums based on the contents and return them to the caller." - }, - "objectSizeBytes": { - "description": "The total size of the server object.", - "format": "int64", - "type": "string" - }, - "objectVersion": { - "description": "The object version of the object the checksums are being returned for.", - "type": "string" - } - }, - "type": "object" - }, - "GdataDiffDownloadResponse": { - "description": "Backend response for a Diff download response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.", - "id": "GdataDiffDownloadResponse", - "properties": { - "objectLocation": { - "$ref": "GdataCompositeMedia", - "description": "The original object location." - } - }, - "type": "object" - }, - "GdataDiffUploadRequest": { - "description": "A Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.", - "id": "GdataDiffUploadRequest", - "properties": { - "checksumsInfo": { - "$ref": "GdataCompositeMedia", - "description": "The location of the checksums for the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received. For details on the format of the checksums, see http://go/scotty-diff-protocol." - }, - "objectInfo": { - "$ref": "GdataCompositeMedia", - "description": "The location of the new object. Agents must clone the object located here, as the upload server will delete the contents once a response is received." - }, - "objectVersion": { - "description": "The object version of the object that is the base version the incoming diff script will be applied to. This field will always be filled in.", - "type": "string" - } - }, - "type": "object" - }, - "GdataDiffUploadResponse": { - "description": "Backend response for a Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.", - "id": "GdataDiffUploadResponse", - "properties": { - "objectVersion": { - "description": "The object version of the object at the server. Must be included in the end notification response. The version in the end notification response must correspond to the new version of the object that is now stored at the server, after the upload.", - "type": "string" - }, - "originalObject": { - "$ref": "GdataCompositeMedia", - "description": "The location of the original file for a diff upload request. Must be filled in if responding to an upload start notification." - } - }, - "type": "object" - }, - "GdataDiffVersionResponse": { - "description": "Backend response for a Diff get version response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.", - "id": "GdataDiffVersionResponse", - "properties": { - "objectSizeBytes": { - "description": "The total size of the server object.", - "format": "int64", - "type": "string" - }, - "objectVersion": { - "description": "The version of the object stored at the server.", - "type": "string" - } - }, - "type": "object" - }, - "GdataDownloadParameters": { - "description": "Parameters specific to media downloads.", - "id": "GdataDownloadParameters", - "properties": { - "allowGzipCompression": { - "description": "A boolean to be returned in the response to Scotty. Allows/disallows gzip encoding of the payload content when the server thinks it's advantageous (hence, does not guarantee compression) which allows Scotty to GZip the response to the client.", - "type": "boolean" - }, - "ignoreRange": { - "description": "Determining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty.", - "type": "boolean" - } - }, - "type": "object" - }, - "GdataMedia": { - "description": "A reference to data stored on the filesystem, on GFS or in blobstore.", - "id": "GdataMedia", - "properties": { - "algorithm": { - "deprecated": true, - "description": "Deprecated, use one of explicit hash type fields instead. Algorithm used for calculating the hash. As of 2011/01/21, \"MD5\" is the only possible value for this field. New values may be added at any time.", - "type": "string" - }, - "bigstoreObjectRef": { - "deprecated": true, - "description": "Use object_id instead.", - "format": "byte", - "type": "string" - }, - "blobRef": { - "deprecated": true, - "description": "Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This should be the byte representation of a blobstore.BlobRef. Since Blobstore is deprecating v1, use blobstore2_info instead. For now, any v2 blob will also be represented in this field as v1 BlobRef.", - "format": "byte", - "type": "string" - }, - "blobstore2Info": { - "$ref": "GdataBlobstore2Info", - "description": "Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob." - }, - "compositeMedia": { - "description": "A composite media composed of one or more media objects, set if reference_type is COMPOSITE_MEDIA. The media length field must be set to the sum of the lengths of all composite media objects. Note: All composite media must have length specified.", - "items": { - "$ref": "GdataCompositeMedia" - }, - "type": "array" - }, - "contentType": { - "description": "MIME type of the data", - "type": "string" - }, - "contentTypeInfo": { - "$ref": "GdataContentTypeInfo", - "description": "Extended content type information provided for Scotty uploads." - }, - "cosmoBinaryReference": { - "description": "A binary data reference for a media download. Serves as a technology-agnostic binary reference in some Google infrastructure. This value is a serialized storage_cosmo.BinaryReference proto. Storing it as bytes is a hack to get around the fact that the cosmo proto (as well as others it includes) doesn't support JavaScript. This prevents us from including the actual type of this field.", - "format": "byte", - "type": "string" - }, - "crc32cHash": { - "description": "For Scotty Uploads: Scotty-provided hashes for uploads For Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.) A Hash provided by the agent to be used to verify the data being downloaded. Currently only supported for inline payloads. Further, only crc32c_hash is currently supported.", - "format": "uint32", - "type": "integer" - }, - "diffChecksumsResponse": { - "$ref": "GdataDiffChecksumsResponse", - "description": "Set if reference_type is DIFF_CHECKSUMS_RESPONSE." - }, - "diffDownloadResponse": { - "$ref": "GdataDiffDownloadResponse", - "description": "Set if reference_type is DIFF_DOWNLOAD_RESPONSE." - }, - "diffUploadRequest": { - "$ref": "GdataDiffUploadRequest", - "description": "Set if reference_type is DIFF_UPLOAD_REQUEST." - }, - "diffUploadResponse": { - "$ref": "GdataDiffUploadResponse", - "description": "Set if reference_type is DIFF_UPLOAD_RESPONSE." - }, - "diffVersionResponse": { - "$ref": "GdataDiffVersionResponse", - "description": "Set if reference_type is DIFF_VERSION_RESPONSE." - }, - "downloadParameters": { - "$ref": "GdataDownloadParameters", - "description": "Parameters for a media download." - }, - "filename": { - "description": "Original file name", - "type": "string" - }, - "hash": { - "deprecated": true, - "description": "Deprecated, use one of explicit hash type fields instead. These two hash related fields will only be populated on Scotty based media uploads and will contain the content of the hash group in the NotificationRequest: http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto\u0026q=class:Hash Hex encoded hash value of the uploaded media.", - "type": "string" - }, - "hashVerified": { - "description": "For Scotty uploads only. If a user sends a hash code and the backend has requested that Scotty verify the upload against the client hash, Scotty will perform the check on behalf of the backend and will reject it if the hashes don't match. This is set to true if Scotty performed this verification.", - "type": "boolean" - }, - "inline": { - "description": "Media data, set if reference_type is INLINE", - "format": "byte", - "type": "string" - }, - "isPotentialRetry": { - "description": "|is_potential_retry| is set false only when Scotty is certain that it has not sent the request before. When a client resumes an upload, this field must be set true in agent calls, because Scotty cannot be certain that it has never sent the request before due to potential failure in the session state persistence.", - "type": "boolean" - }, - "length": { - "description": "Size of the data, in bytes", - "format": "int64", - "type": "string" - }, - "md5Hash": { - "description": "Scotty-provided MD5 hash for an upload.", - "format": "byte", - "type": "string" - }, - "mediaId": { - "description": "Media id to forward to the operation GetMedia. Can be set if reference_type is GET_MEDIA.", - "format": "byte", - "type": "string" - }, - "objectId": { - "$ref": "GdataObjectId", - "description": "Reference to a TI Blob, set if reference_type is BIGSTORE_REF." - }, - "path": { - "description": "Path to the data, set if reference_type is PATH", - "type": "string" - }, - "referenceType": { - "description": "Describes what the field reference contains.", - "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" - ], - "enumDescriptions": [ - "Reference contains a GFS path or a local path.", - "Reference points to a blobstore object. This could be either a v1 blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info first, since v1 is being deprecated.", - "Data is included into this proto buffer", - "Data should be accessed from the current service using the operation GetMedia.", - "The content for this media object is stored across multiple partial media objects under the composite_media field.", - "Reference points to a bigstore object", - "Indicates the data is stored in diff_version_response.", - "Indicates the data is stored in diff_checksums_response.", - "Indicates the data is stored in diff_download_response.", - "Indicates the data is stored in diff_upload_request.", - "Indicates the data is stored in diff_upload_response.", - "Indicates the data is stored in cosmo_binary_reference.", - "Informs Scotty to generate a response payload with the size specified in the length field. The contents of the payload are generated by Scotty and are undefined. This is useful for testing download speeds between the user and Scotty without involving a real payload source. Note: range is not supported when using arbitrary_bytes." - ], - "type": "string" - }, - "sha1Hash": { - "description": "Scotty-provided SHA1 hash for an upload.", - "format": "byte", - "type": "string" - }, - "sha256Hash": { - "description": "Scotty-provided SHA256 hash for an upload.", - "format": "byte", - "type": "string" - }, - "timestamp": { - "description": "Time at which the media data was last updated, in milliseconds since UNIX epoch", - "format": "uint64", - "type": "string" - }, - "token": { - "description": "A unique fingerprint/version id for the media data", - "type": "string" - } - }, - "type": "object" - }, - "GdataObjectId": { - "description": "This is a copy of the tech.blob.ObjectId proto, which could not be used directly here due to transitive closure issues with JavaScript support; see http://b/8801763.", - "id": "GdataObjectId", - "properties": { - "bucketName": { - "description": "The name of the bucket to which this object belongs.", - "type": "string" - }, - "generation": { - "description": "Generation of the object. Generations are monotonically increasing across writes, allowing them to be be compared to determine which generation is newer. If this is omitted in a request, then you are requesting the live object. See http://go/bigstore-versions", - "format": "int64", - "type": "string" - }, - "objectName": { - "description": "The name of the object.", - "type": "string" - } - }, - "type": "object" - }, "GoogleApiDistribution": { "description": "`Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless.", "id": "GoogleApiDistribution", @@ -9845,6 +9508,14 @@ "$ref": "GoogleCloudDiscoveryengineV1AssistantCustomerPolicy", "description": "Optional. Customer policy for the assistant." }, + "description": { + "description": "Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.", + "type": "string" + }, + "displayName": { + "description": "Required. The assistant display name. It must be a UTF-8 encoded string with a length limit of 128 characters.", + "type": "string" + }, "enabledTools": { "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1AssistantToolList" @@ -9959,10 +9630,21 @@ "description": "Configuration for the generation of the assistant response.", "id": "GoogleCloudDiscoveryengineV1AssistantGenerationConfig", "properties": { + "allowedModelIds": { + "description": "Optional. The list of models that are allowed to be used for assistant.", + "items": { + "type": "string" + }, + "type": "array" + }, "defaultLanguage": { "description": "The default language to use for the generation of the assistant response. Use an ISO 639-1 language code such as `en`. If not specified, the language will be automatically detected.", "type": "string" }, + "defaultModelId": { + "description": "Optional. The default model to use for assistant.", + "type": "string" + }, "systemInstruction": { "$ref": "GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction", "description": "System instruction, also known as the prompt preamble for LLM calls. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions" @@ -18833,6 +18515,13 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", "description": "A specification for configuring the behavior of content search." }, + "crowdingSpecs": { + "description": "Optional. Crowding specifications for improving result diversity. If multiple CrowdingSpecs are specified, crowding will be evaluated on each unique combination of the `field` values, and max_count will be the maximum value of `max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec has `field` = \"color\" and `max_count` = 3, and the second CrowdingSpec has `field` = \"size\" and `max_count` = 2, then after 3 documents that share the same color AND size have been returned, subsequent ones should be removed or demoted.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec" + }, + "type": "array" + }, "customFineTuningSpec": { "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", "description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec." @@ -18889,6 +18578,13 @@ "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" }, + "pageCategories": { + "description": "Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. To represent full path of a category, use '\u003e' character to separate different hierarchies. If '\u003e' is part of the category name, replace it with other character(s). For example, `Graphics Cards \u003e RTX\u003e4090 \u003e Founders Edition` where \"RTX \u003e 4090\" represents one level, can be rewritten as `Graphics Cards \u003e RTX_4090 \u003e Founders Edition`", + "items": { + "type": "string" + }, + "type": "array" + }, "pageSize": { "description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.", "format": "int32", @@ -19320,6 +19016,36 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec": { + "description": "Specification for crowding. Crowding improves the diversity of search results by limiting the number of results that share the same field value. For example, crowding on the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will return at most 3 results with the same color across all pages.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec", + "properties": { + "field": { + "description": "The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.", + "type": "string" + }, + "maxCount": { + "description": "The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in `order_by`), later results with the same value are \"crowded away\". If not specified, the default value is 1.", + "format": "int32", + "type": "integer" + }, + "mode": { + "description": "Mode to use for documents that are crowded away.", + "enum": [ + "MODE_UNSPECIFIED", + "DROP_CROWDED_RESULTS", + "DEMOTE_CROWDED_RESULTS_TO_END" + ], + "enumDescriptions": [ + "Unspecified crowding mode. In this case, server behavior defaults to Mode.DROP_CROWDED_RESULTS.", + "Drop crowded results.", + "Demote crowded results to the later pages." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec": { "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec", @@ -22127,6 +21853,14 @@ "$ref": "GoogleCloudDiscoveryengineV1betaAssistantCustomerPolicy", "description": "Optional. Customer policy for the assistant." }, + "description": { + "description": "Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant.", + "type": "string" + }, + "displayName": { + "description": "Required. The assistant display name. It must be a UTF-8 encoded string with a length limit of 128 characters.", + "type": "string" + }, "enabledTools": { "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1betaAssistantToolList" @@ -22345,10 +22079,21 @@ "description": "Configuration for the generation of the assistant response.", "id": "GoogleCloudDiscoveryengineV1betaAssistantGenerationConfig", "properties": { + "allowedModelIds": { + "description": "Optional. The list of models that are allowed to be used for assistant.", + "items": { + "type": "string" + }, + "type": "array" + }, "defaultLanguage": { "description": "The default language to use for the generation of the assistant response. Use an ISO 639-1 language code such as `en`. If not specified, the language will be automatically detected.", "type": "string" }, + "defaultModelId": { + "description": "Optional. The default model to use for assistant.", + "type": "string" + }, "systemInstruction": { "$ref": "GoogleCloudDiscoveryengineV1betaAssistantGenerationConfigSystemInstruction", "description": "System instruction, also known as the prompt preamble for LLM calls. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions" @@ -26276,6 +26021,24 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaListAssistantsResponse": { + "description": "Response message for the AssistantService.ListAssistants method.", + "id": "GoogleCloudDiscoveryengineV1betaListAssistantsResponse", + "properties": { + "assistants": { + "description": "All the customer's Assistants.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaAssistant" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token that can be sent as ListAssistantsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaListCmekConfigsResponse": { "description": "Response message for CmekConfigService.ListCmekConfigs method.", "id": "GoogleCloudDiscoveryengineV1betaListCmekConfigsResponse", @@ -27852,6 +27615,13 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec", "description": "A specification for configuring the behavior of content search." }, + "crowdingSpecs": { + "description": "Optional. Crowding specifications for improving result diversity. If multiple CrowdingSpecs are specified, crowding will be evaluated on each unique combination of the `field` values, and max_count will be the maximum value of `max_count` across all CrowdingSpecs. For example, if the first CrowdingSpec has `field` = \"color\" and `max_count` = 3, and the second CrowdingSpec has `field` = \"size\" and `max_count` = 2, then after 3 documents that share the same color AND size have been returned, subsequent ones should be removed or demoted.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec" + }, + "type": "array" + }, "dataStoreSpecs": { "description": "Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", "items": { @@ -27904,6 +27674,13 @@ "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" }, + "pageCategories": { + "description": "Optional. The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.PageInfo.page_category. This field is the equivalent of the query for browse (navigation) queries. It's used by the browse model when the query is empty. If the field is empty, it will not be used by the browse model. To represent full path of a category, use '\u003e' character to separate different hierarchies. If '\u003e' is part of the category name, replace it with other character(s). For example, `Graphics Cards \u003e RTX\u003e4090 \u003e Founders Edition` where \"RTX \u003e 4090\" represents one level, can be rewritten as `Graphics Cards \u003e RTX_4090 \u003e Founders Edition`", + "items": { + "type": "string" + }, + "type": "array" + }, "pageSize": { "description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.", "format": "int32", @@ -28331,6 +28108,36 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec": { + "description": "Specification for crowding. Crowding improves the diversity of search results by limiting the number of results that share the same field value. For example, crowding on the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will return at most 3 results with the same color across all pages.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec", + "properties": { + "field": { + "description": "The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.", + "type": "string" + }, + "maxCount": { + "description": "The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in `order_by`), later results with the same value are \"crowded away\". If not specified, the default value is 1.", + "format": "int32", + "type": "integer" + }, + "mode": { + "description": "Mode to use for documents that are crowded away.", + "enum": [ + "MODE_UNSPECIFIED", + "DROP_CROWDED_RESULTS", + "DEMOTE_CROWDED_RESULTS_TO_END" + ], + "enumDescriptions": [ + "Unspecified crowding mode. In this case, server behavior defaults to Mode.DROP_CROWDED_RESULTS.", + "Drop crowded results.", + "Demote crowded results to the later pages." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec": { "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec", @@ -30031,6 +29838,13 @@ "description": "A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support.", "type": "string" }, + "invocationTools": { + "description": "The tool names of the tools that were invoked.", + "items": { + "type": "string" + }, + "type": "array" + }, "sessionInfo": { "$ref": "GoogleCloudDiscoveryengineV1betaStreamAssistResponseSessionInfo", "description": "Session information. Only included in the final StreamAssistResponse of the response stream." @@ -30666,7 +30480,7 @@ "type": "array" }, "unreachable": { - "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, diff --git a/discoveryengine/v1beta/discoveryengine-gen.go b/discoveryengine/v1beta/discoveryengine-gen.go index eda09b83183..b4d425b74c0 100644 --- a/discoveryengine/v1beta/discoveryengine-gen.go +++ b/discoveryengine/v1beta/discoveryengine-gen.go @@ -141,7 +141,6 @@ func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, err return nil, err } s := &Service{client: client, BasePath: basePath, logger: internaloption.GetLogger(opts)} - s.Media = NewMediaService(s) s.Projects = NewProjectsService(s) if endpoint != "" { s.BasePath = endpoint @@ -167,8 +166,6 @@ type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment - Media *MediaService - Projects *ProjectsService } @@ -179,15 +176,6 @@ func (s *Service) userAgent() string { return googleapi.UserAgent + " " + s.UserAgent } -func NewMediaService(s *Service) *MediaService { - rs := &MediaService{s: s} - return rs -} - -type MediaService struct { - s *Service -} - func NewProjectsService(s *Service) *ProjectsService { rs := &ProjectsService{s: s} rs.Locations = NewProjectsLocationsService(s) @@ -619,11 +607,35 @@ type ProjectsLocationsCollectionsEnginesService struct { func NewProjectsLocationsCollectionsEnginesAssistantsService(s *Service) *ProjectsLocationsCollectionsEnginesAssistantsService { rs := &ProjectsLocationsCollectionsEnginesAssistantsService{s: s} + rs.Agents = NewProjectsLocationsCollectionsEnginesAssistantsAgentsService(s) return rs } type ProjectsLocationsCollectionsEnginesAssistantsService struct { s *Service + + Agents *ProjectsLocationsCollectionsEnginesAssistantsAgentsService +} + +func NewProjectsLocationsCollectionsEnginesAssistantsAgentsService(s *Service) *ProjectsLocationsCollectionsEnginesAssistantsAgentsService { + rs := &ProjectsLocationsCollectionsEnginesAssistantsAgentsService{s: s} + rs.Operations = NewProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsService(s) + return rs +} + +type ProjectsLocationsCollectionsEnginesAssistantsAgentsService struct { + s *Service + + Operations *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsService +} + +func NewProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsService(s *Service) *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsService { + rs := &ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsService{s: s} + return rs +} + +type ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsService struct { + s *Service } func NewProjectsLocationsCollectionsEnginesCompletionConfigService(s *Service) *ProjectsLocationsCollectionsEnginesCompletionConfigService { @@ -1121,502 +1133,6 @@ type ProjectsOperationsService struct { s *Service } -// GdataBlobstore2Info: Information to read/write to blobstore2. -type GdataBlobstore2Info struct { - // BlobGeneration: The blob generation id. - BlobGeneration int64 `json:"blobGeneration,omitempty,string"` - // BlobId: The blob id, e.g., /blobstore/prod/playground/scotty - BlobId string `json:"blobId,omitempty"` - // DownloadReadHandle: Read handle passed from Bigstore -> Scotty for a GCS - // download. This is a signed, serialized blobstore2.ReadHandle proto which - // must never be set outside of Bigstore, and is not applicable to non-GCS - // media downloads. - DownloadReadHandle string `json:"downloadReadHandle,omitempty"` - // ReadToken: The blob read token. Needed to read blobs that have not been - // replicated. Might not be available until the final call. - ReadToken string `json:"readToken,omitempty"` - // UploadMetadataContainer: Metadata passed from Blobstore -> Scotty for a new - // GCS upload. This is a signed, serialized blobstore2.BlobMetadataContainer - // proto which must never be consumed outside of Bigstore, and is not - // applicable to non-GCS media uploads. - UploadMetadataContainer string `json:"uploadMetadataContainer,omitempty"` - // ForceSendFields is a list of field names (e.g. "BlobGeneration") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "BlobGeneration") to include in - // API requests with the JSON null value. By default, fields with empty values - // are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataBlobstore2Info) MarshalJSON() ([]byte, error) { - type NoMethod GdataBlobstore2Info - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GdataCompositeMedia: A sequence of media data references representing -// composite data. Introduced to support Bigstore composite objects. For -// details, visit http://go/bigstore-composites. -type GdataCompositeMedia struct { - // BlobRef: Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This - // should be the byte representation of a blobstore.BlobRef. Since Blobstore is - // deprecating v1, use blobstore2_info instead. For now, any v2 blob will also - // be represented in this field as v1 BlobRef. - BlobRef string `json:"blobRef,omitempty"` - // Blobstore2Info: Blobstore v2 info, set if reference_type is BLOBSTORE_REF - // and it refers to a v2 blob. - Blobstore2Info *GdataBlobstore2Info `json:"blobstore2Info,omitempty"` - // CosmoBinaryReference: A binary data reference for a media download. Serves - // as a technology-agnostic binary reference in some Google infrastructure. - // This value is a serialized storage_cosmo.BinaryReference proto. Storing it - // as bytes is a hack to get around the fact that the cosmo proto (as well as - // others it includes) doesn't support JavaScript. This prevents us from - // including the actual type of this field. - CosmoBinaryReference string `json:"cosmoBinaryReference,omitempty"` - // Crc32cHash: crc32.c hash for the payload. - Crc32cHash int64 `json:"crc32cHash,omitempty"` - // Inline: Media data, set if reference_type is INLINE - Inline string `json:"inline,omitempty"` - // Length: Size of the data, in bytes - Length int64 `json:"length,omitempty,string"` - // Md5Hash: MD5 hash for the payload. - Md5Hash string `json:"md5Hash,omitempty"` - // ObjectId: Reference to a TI Blob, set if reference_type is BIGSTORE_REF. - ObjectId *GdataObjectId `json:"objectId,omitempty"` - // Path: Path to the data, set if reference_type is PATH - Path string `json:"path,omitempty"` - // ReferenceType: Describes what the field reference contains. - // - // Possible values: - // "PATH" - Reference contains a GFS path or a local path. - // "BLOB_REF" - Reference points to a blobstore object. This could be either - // a v1 blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info - // first, since v1 is being deprecated. - // "INLINE" - Data is included into this proto buffer - // "BIGSTORE_REF" - Reference points to a bigstore object - // "COSMO_BINARY_REFERENCE" - Indicates the data is stored in - // cosmo_binary_reference. - ReferenceType string `json:"referenceType,omitempty"` - // Sha1Hash: SHA-1 hash for the payload. - Sha1Hash string `json:"sha1Hash,omitempty"` - // ForceSendFields is a list of field names (e.g. "BlobRef") to unconditionally - // include in API requests. By default, fields with empty or default values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "BlobRef") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataCompositeMedia) MarshalJSON() ([]byte, error) { - type NoMethod GdataCompositeMedia - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GdataContentTypeInfo: Detailed Content-Type information from Scotty. The -// Content-Type of the media will typically be filled in by the header or -// Scotty's best_guess, but this extended information provides the backend with -// more information so that it can make a better decision if needed. This is -// only used on media upload requests from Scotty. -type GdataContentTypeInfo struct { - // BestGuess: Scotty's best guess of what the content type of the file is. - BestGuess string `json:"bestGuess,omitempty"` - // FromBytes: The content type of the file derived by looking at specific bytes - // (i.e. "magic bytes") of the actual file. - FromBytes string `json:"fromBytes,omitempty"` - // FromFileName: The content type of the file derived from the file extension - // of the original file name used by the client. - FromFileName string `json:"fromFileName,omitempty"` - // FromHeader: The content type of the file as specified in the request - // headers, multipart headers, or RUPIO start request. - FromHeader string `json:"fromHeader,omitempty"` - // FromUrlPath: The content type of the file derived from the file extension of - // the URL path. The URL path is assumed to represent a file name (which is - // typically only true for agents that are providing a REST API). - FromUrlPath string `json:"fromUrlPath,omitempty"` - // ForceSendFields is a list of field names (e.g. "BestGuess") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "BestGuess") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataContentTypeInfo) MarshalJSON() ([]byte, error) { - type NoMethod GdataContentTypeInfo - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GdataDiffChecksumsResponse: Backend response for a Diff get checksums -// response. For details on the Scotty Diff protocol, visit -// http://go/scotty-diff-protocol. -type GdataDiffChecksumsResponse struct { - // ChecksumsLocation: Exactly one of these fields must be populated. If - // checksums_location is filled, the server will return the corresponding - // contents to the user. If object_location is filled, the server will - // calculate the checksums based on the content there and return that to the - // user. For details on the format of the checksums, see - // http://go/scotty-diff-protocol. - ChecksumsLocation *GdataCompositeMedia `json:"checksumsLocation,omitempty"` - // ChunkSizeBytes: The chunk size of checksums. Must be a multiple of 256KB. - ChunkSizeBytes int64 `json:"chunkSizeBytes,omitempty,string"` - // ObjectLocation: If set, calculate the checksums based on the contents and - // return them to the caller. - ObjectLocation *GdataCompositeMedia `json:"objectLocation,omitempty"` - // ObjectSizeBytes: The total size of the server object. - ObjectSizeBytes int64 `json:"objectSizeBytes,omitempty,string"` - // ObjectVersion: The object version of the object the checksums are being - // returned for. - ObjectVersion string `json:"objectVersion,omitempty"` - // ForceSendFields is a list of field names (e.g. "ChecksumsLocation") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "ChecksumsLocation") to include in - // API requests with the JSON null value. By default, fields with empty values - // are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataDiffChecksumsResponse) MarshalJSON() ([]byte, error) { - type NoMethod GdataDiffChecksumsResponse - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GdataDiffDownloadResponse: Backend response for a Diff download response. -// For details on the Scotty Diff protocol, visit -// http://go/scotty-diff-protocol. -type GdataDiffDownloadResponse struct { - // ObjectLocation: The original object location. - ObjectLocation *GdataCompositeMedia `json:"objectLocation,omitempty"` - // ForceSendFields is a list of field names (e.g. "ObjectLocation") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "ObjectLocation") to include in - // API requests with the JSON null value. By default, fields with empty values - // are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataDiffDownloadResponse) MarshalJSON() ([]byte, error) { - type NoMethod GdataDiffDownloadResponse - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GdataDiffUploadRequest: A Diff upload request. For details on the Scotty -// Diff protocol, visit http://go/scotty-diff-protocol. -type GdataDiffUploadRequest struct { - // ChecksumsInfo: The location of the checksums for the new object. Agents must - // clone the object located here, as the upload server will delete the contents - // once a response is received. For details on the format of the checksums, see - // http://go/scotty-diff-protocol. - ChecksumsInfo *GdataCompositeMedia `json:"checksumsInfo,omitempty"` - // ObjectInfo: The location of the new object. Agents must clone the object - // located here, as the upload server will delete the contents once a response - // is received. - ObjectInfo *GdataCompositeMedia `json:"objectInfo,omitempty"` - // ObjectVersion: The object version of the object that is the base version the - // incoming diff script will be applied to. This field will always be filled - // in. - ObjectVersion string `json:"objectVersion,omitempty"` - // ForceSendFields is a list of field names (e.g. "ChecksumsInfo") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "ChecksumsInfo") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataDiffUploadRequest) MarshalJSON() ([]byte, error) { - type NoMethod GdataDiffUploadRequest - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GdataDiffUploadResponse: Backend response for a Diff upload request. For -// details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol. -type GdataDiffUploadResponse struct { - // ObjectVersion: The object version of the object at the server. Must be - // included in the end notification response. The version in the end - // notification response must correspond to the new version of the object that - // is now stored at the server, after the upload. - ObjectVersion string `json:"objectVersion,omitempty"` - // OriginalObject: The location of the original file for a diff upload request. - // Must be filled in if responding to an upload start notification. - OriginalObject *GdataCompositeMedia `json:"originalObject,omitempty"` - // ForceSendFields is a list of field names (e.g. "ObjectVersion") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "ObjectVersion") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataDiffUploadResponse) MarshalJSON() ([]byte, error) { - type NoMethod GdataDiffUploadResponse - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GdataDiffVersionResponse: Backend response for a Diff get version response. -// For details on the Scotty Diff protocol, visit -// http://go/scotty-diff-protocol. -type GdataDiffVersionResponse struct { - // ObjectSizeBytes: The total size of the server object. - ObjectSizeBytes int64 `json:"objectSizeBytes,omitempty,string"` - // ObjectVersion: The version of the object stored at the server. - ObjectVersion string `json:"objectVersion,omitempty"` - // ForceSendFields is a list of field names (e.g. "ObjectSizeBytes") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "ObjectSizeBytes") to include in - // API requests with the JSON null value. By default, fields with empty values - // are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataDiffVersionResponse) MarshalJSON() ([]byte, error) { - type NoMethod GdataDiffVersionResponse - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GdataDownloadParameters: Parameters specific to media downloads. -type GdataDownloadParameters struct { - // AllowGzipCompression: A boolean to be returned in the response to Scotty. - // Allows/disallows gzip encoding of the payload content when the server thinks - // it's advantageous (hence, does not guarantee compression) which allows - // Scotty to GZip the response to the client. - AllowGzipCompression bool `json:"allowGzipCompression,omitempty"` - // IgnoreRange: Determining whether or not Apiary should skip the inclusion of - // any Content-Range header on its response to Scotty. - IgnoreRange bool `json:"ignoreRange,omitempty"` - // ForceSendFields is a list of field names (e.g. "AllowGzipCompression") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "AllowGzipCompression") to include - // in API requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataDownloadParameters) MarshalJSON() ([]byte, error) { - type NoMethod GdataDownloadParameters - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GdataMedia: A reference to data stored on the filesystem, on GFS or in -// blobstore. -type GdataMedia struct { - // Algorithm: Deprecated, use one of explicit hash type fields instead. - // Algorithm used for calculating the hash. As of 2011/01/21, "MD5" is the only - // possible value for this field. New values may be added at any time. - Algorithm string `json:"algorithm,omitempty"` - // BigstoreObjectRef: Use object_id instead. - BigstoreObjectRef string `json:"bigstoreObjectRef,omitempty"` - // BlobRef: Blobstore v1 reference, set if reference_type is BLOBSTORE_REF This - // should be the byte representation of a blobstore.BlobRef. Since Blobstore is - // deprecating v1, use blobstore2_info instead. For now, any v2 blob will also - // be represented in this field as v1 BlobRef. - BlobRef string `json:"blobRef,omitempty"` - // Blobstore2Info: Blobstore v2 info, set if reference_type is BLOBSTORE_REF - // and it refers to a v2 blob. - Blobstore2Info *GdataBlobstore2Info `json:"blobstore2Info,omitempty"` - // CompositeMedia: A composite media composed of one or more media objects, set - // if reference_type is COMPOSITE_MEDIA. The media length field must be set to - // the sum of the lengths of all composite media objects. Note: All composite - // media must have length specified. - CompositeMedia []*GdataCompositeMedia `json:"compositeMedia,omitempty"` - // ContentType: MIME type of the data - ContentType string `json:"contentType,omitempty"` - // ContentTypeInfo: Extended content type information provided for Scotty - // uploads. - ContentTypeInfo *GdataContentTypeInfo `json:"contentTypeInfo,omitempty"` - // CosmoBinaryReference: A binary data reference for a media download. Serves - // as a technology-agnostic binary reference in some Google infrastructure. - // This value is a serialized storage_cosmo.BinaryReference proto. Storing it - // as bytes is a hack to get around the fact that the cosmo proto (as well as - // others it includes) doesn't support JavaScript. This prevents us from - // including the actual type of this field. - CosmoBinaryReference string `json:"cosmoBinaryReference,omitempty"` - // Crc32cHash: For Scotty Uploads: Scotty-provided hashes for uploads For - // Scotty Downloads: (WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY - // TEAM.) A Hash provided by the agent to be used to verify the data being - // downloaded. Currently only supported for inline payloads. Further, only - // crc32c_hash is currently supported. - Crc32cHash int64 `json:"crc32cHash,omitempty"` - // DiffChecksumsResponse: Set if reference_type is DIFF_CHECKSUMS_RESPONSE. - DiffChecksumsResponse *GdataDiffChecksumsResponse `json:"diffChecksumsResponse,omitempty"` - // DiffDownloadResponse: Set if reference_type is DIFF_DOWNLOAD_RESPONSE. - DiffDownloadResponse *GdataDiffDownloadResponse `json:"diffDownloadResponse,omitempty"` - // DiffUploadRequest: Set if reference_type is DIFF_UPLOAD_REQUEST. - DiffUploadRequest *GdataDiffUploadRequest `json:"diffUploadRequest,omitempty"` - // DiffUploadResponse: Set if reference_type is DIFF_UPLOAD_RESPONSE. - DiffUploadResponse *GdataDiffUploadResponse `json:"diffUploadResponse,omitempty"` - // DiffVersionResponse: Set if reference_type is DIFF_VERSION_RESPONSE. - DiffVersionResponse *GdataDiffVersionResponse `json:"diffVersionResponse,omitempty"` - // DownloadParameters: Parameters for a media download. - DownloadParameters *GdataDownloadParameters `json:"downloadParameters,omitempty"` - // Filename: Original file name - Filename string `json:"filename,omitempty"` - // Hash: Deprecated, use one of explicit hash type fields instead. These two - // hash related fields will only be populated on Scotty based media uploads and - // will contain the content of the hash group in the NotificationRequest: - // http://cs/#google3/blobstore2/api/scotty/service/proto/upload_listener.proto&q=class:Hash - // Hex encoded hash value of the uploaded media. - Hash string `json:"hash,omitempty"` - // HashVerified: For Scotty uploads only. If a user sends a hash code and the - // backend has requested that Scotty verify the upload against the client hash, - // Scotty will perform the check on behalf of the backend and will reject it if - // the hashes don't match. This is set to true if Scotty performed this - // verification. - HashVerified bool `json:"hashVerified,omitempty"` - // Inline: Media data, set if reference_type is INLINE - Inline string `json:"inline,omitempty"` - // IsPotentialRetry: |is_potential_retry| is set false only when Scotty is - // certain that it has not sent the request before. When a client resumes an - // upload, this field must be set true in agent calls, because Scotty cannot be - // certain that it has never sent the request before due to potential failure - // in the session state persistence. - IsPotentialRetry bool `json:"isPotentialRetry,omitempty"` - // Length: Size of the data, in bytes - Length int64 `json:"length,omitempty,string"` - // Md5Hash: Scotty-provided MD5 hash for an upload. - Md5Hash string `json:"md5Hash,omitempty"` - // MediaId: Media id to forward to the operation GetMedia. Can be set if - // reference_type is GET_MEDIA. - MediaId string `json:"mediaId,omitempty"` - // ObjectId: Reference to a TI Blob, set if reference_type is BIGSTORE_REF. - ObjectId *GdataObjectId `json:"objectId,omitempty"` - // Path: Path to the data, set if reference_type is PATH - Path string `json:"path,omitempty"` - // ReferenceType: Describes what the field reference contains. - // - // Possible values: - // "PATH" - Reference contains a GFS path or a local path. - // "BLOB_REF" - Reference points to a blobstore object. This could be either - // a v1 blob_ref or a v2 blobstore2_info. Clients should check blobstore2_info - // first, since v1 is being deprecated. - // "INLINE" - Data is included into this proto buffer - // "GET_MEDIA" - Data should be accessed from the current service using the - // operation GetMedia. - // "COMPOSITE_MEDIA" - The content for this media object is stored across - // multiple partial media objects under the composite_media field. - // "BIGSTORE_REF" - Reference points to a bigstore object - // "DIFF_VERSION_RESPONSE" - Indicates the data is stored in - // diff_version_response. - // "DIFF_CHECKSUMS_RESPONSE" - Indicates the data is stored in - // diff_checksums_response. - // "DIFF_DOWNLOAD_RESPONSE" - Indicates the data is stored in - // diff_download_response. - // "DIFF_UPLOAD_REQUEST" - Indicates the data is stored in - // diff_upload_request. - // "DIFF_UPLOAD_RESPONSE" - Indicates the data is stored in - // diff_upload_response. - // "COSMO_BINARY_REFERENCE" - Indicates the data is stored in - // cosmo_binary_reference. - // "ARBITRARY_BYTES" - Informs Scotty to generate a response payload with the - // size specified in the length field. The contents of the payload are - // generated by Scotty and are undefined. This is useful for testing download - // speeds between the user and Scotty without involving a real payload source. - // Note: range is not supported when using arbitrary_bytes. - ReferenceType string `json:"referenceType,omitempty"` - // Sha1Hash: Scotty-provided SHA1 hash for an upload. - Sha1Hash string `json:"sha1Hash,omitempty"` - // Sha256Hash: Scotty-provided SHA256 hash for an upload. - Sha256Hash string `json:"sha256Hash,omitempty"` - // Timestamp: Time at which the media data was last updated, in milliseconds - // since UNIX epoch - Timestamp uint64 `json:"timestamp,omitempty,string"` - // Token: A unique fingerprint/version id for the media data - Token string `json:"token,omitempty"` - - // ServerResponse contains the HTTP response code and headers from the server. - googleapi.ServerResponse `json:"-"` - // ForceSendFields is a list of field names (e.g. "Algorithm") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Algorithm") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataMedia) MarshalJSON() ([]byte, error) { - type NoMethod GdataMedia - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - -// GdataObjectId: This is a copy of the tech.blob.ObjectId proto, which could -// not be used directly here due to transitive closure issues with JavaScript -// support; see http://b/8801763. -type GdataObjectId struct { - // BucketName: The name of the bucket to which this object belongs. - BucketName string `json:"bucketName,omitempty"` - // Generation: Generation of the object. Generations are monotonically - // increasing across writes, allowing them to be be compared to determine which - // generation is newer. If this is omitted in a request, then you are - // requesting the live object. See http://go/bigstore-versions - Generation int64 `json:"generation,omitempty,string"` - // ObjectName: The name of the object. - ObjectName string `json:"objectName,omitempty"` - // ForceSendFields is a list of field names (e.g. "BucketName") to - // unconditionally include in API requests. By default, fields with empty or - // default values are omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more - // details. - ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "BucketName") to include in API - // requests with the JSON null value. By default, fields with empty values are - // omitted from API requests. See - // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. - NullFields []string `json:"-"` -} - -func (s GdataObjectId) MarshalJSON() ([]byte, error) { - type NoMethod GdataObjectId - return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) -} - // GoogleApiDistribution: `Distribution` contains summary statistics for a // population of values. It optionally contains a histogram representing the // distribution of those values across a set of buckets. The summary statistics @@ -2572,6 +2088,12 @@ func (s *GoogleCloudDiscoveryengineV1AnswerGenerationSpecUserDefinedClassifierSp type GoogleCloudDiscoveryengineV1Assistant struct { // CustomerPolicy: Optional. Customer policy for the assistant. CustomerPolicy *GoogleCloudDiscoveryengineV1AssistantCustomerPolicy `json:"customerPolicy,omitempty"` + // Description: Optional. Description for additional information. Expected to + // be shown on the configuration UI, not to the users of the assistant. + Description string `json:"description,omitempty"` + // DisplayName: Required. The assistant display name. It must be a UTF-8 + // encoded string with a length limit of 128 characters. + DisplayName string `json:"displayName,omitempty"` // EnabledTools: Optional. Note: not implemented yet. Use enabled_actions // instead. The enabled tools on this assistant. The keys are connector name, // for example @@ -2730,21 +2252,26 @@ func (s GoogleCloudDiscoveryengineV1AssistantCustomerPolicyModelArmorConfig) Mar // GoogleCloudDiscoveryengineV1AssistantGenerationConfig: Configuration for the // generation of the assistant response. type GoogleCloudDiscoveryengineV1AssistantGenerationConfig struct { + // AllowedModelIds: Optional. The list of models that are allowed to be used + // for assistant. + AllowedModelIds []string `json:"allowedModelIds,omitempty"` // DefaultLanguage: The default language to use for the generation of the // assistant response. Use an ISO 639-1 language code such as `en`. If not // specified, the language will be automatically detected. DefaultLanguage string `json:"defaultLanguage,omitempty"` + // DefaultModelId: Optional. The default model to use for assistant. + DefaultModelId string `json:"defaultModelId,omitempty"` // SystemInstruction: System instruction, also known as the prompt preamble for // LLM calls. See also // https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions SystemInstruction *GoogleCloudDiscoveryengineV1AssistantGenerationConfigSystemInstruction `json:"systemInstruction,omitempty"` - // ForceSendFields is a list of field names (e.g. "DefaultLanguage") to + // ForceSendFields is a list of field names (e.g. "AllowedModelIds") to // unconditionally include in API requests. By default, fields with empty or // default values are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "DefaultLanguage") to include in + // NullFields is a list of field names (e.g. "AllowedModelIds") to include in // API requests with the JSON null value. By default, fields with empty values // are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. @@ -13907,6 +13434,15 @@ type GoogleCloudDiscoveryengineV1alphaSearchRequest struct { // ContentSearchSpec: A specification for configuring the behavior of content // search. ContentSearchSpec *GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec `json:"contentSearchSpec,omitempty"` + // CrowdingSpecs: Optional. Crowding specifications for improving result + // diversity. If multiple CrowdingSpecs are specified, crowding will be + // evaluated on each unique combination of the `field` values, and max_count + // will be the maximum value of `max_count` across all CrowdingSpecs. For + // example, if the first CrowdingSpec has `field` = "color" and `max_count` = + // 3, and the second CrowdingSpec has `field` = "size" and `max_count` = 2, + // then after 3 documents that share the same color AND size have been + // returned, subsequent ones should be removed or demoted. + CrowdingSpecs []*GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec `json:"crowdingSpecs,omitempty"` // CustomFineTuningSpec: Custom fine tuning configs. If set, it has higher // priority than the configs set in ServingConfig.custom_fine_tuning_spec. CustomFineTuningSpec *GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec `json:"customFineTuningSpec,omitempty"` @@ -13976,6 +13512,17 @@ type GoogleCloudDiscoveryengineV1alphaSearchRequest struct { // (https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). // If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. OrderBy string `json:"orderBy,omitempty"` + // PageCategories: Optional. The categories associated with a category page. + // Must be set for category navigation queries to achieve good search quality. + // The format should be the same as UserEvent.PageInfo.page_category. This + // field is the equivalent of the query for browse (navigation) queries. It's + // used by the browse model when the query is empty. If the field is empty, it + // will not be used by the browse model. To represent full path of a category, + // use '>' character to separate different hierarchies. If '>' is part of the + // category name, replace it with other character(s). For example, `Graphics + // Cards > RTX>4090 > Founders Edition` where "RTX > 4090" represents one + // level, can be rewritten as `Graphics Cards > RTX_4090 > Founders Edition` + PageCategories []string `json:"pageCategories,omitempty"` // PageSize: Maximum number of Documents to return. The maximum allowed value // depends on the data type. Values above the maximum value are coerced to the // maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * @@ -14712,6 +14259,48 @@ func (s GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySp return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec: Specification +// for crowding. Crowding improves the diversity of search results by limiting +// the number of results that share the same field value. For example, crowding +// on the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will +// return at most 3 results with the same color across all pages. +type GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec struct { + // Field: The field to use for crowding. Documents can be crowded by a field in + // the Document object. Crowding field is case sensitive. + Field string `json:"field,omitempty"` + // MaxCount: The maximum number of documents to keep per value of the field. + // Once there are at least max_count previous results which contain the same + // value for the given field (according to the order specified in `order_by`), + // later results with the same value are "crowded away". If not specified, the + // default value is 1. + MaxCount int64 `json:"maxCount,omitempty"` + // Mode: Mode to use for documents that are crowded away. + // + // Possible values: + // "MODE_UNSPECIFIED" - Unspecified crowding mode. In this case, server + // behavior defaults to Mode.DROP_CROWDED_RESULTS. + // "DROP_CROWDED_RESULTS" - Drop crowded results. + // "DEMOTE_CROWDED_RESULTS_TO_END" - Demote crowded results to the later + // pages. + Mode string `json:"mode,omitempty"` + // ForceSendFields is a list of field names (e.g. "Field") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Field") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1alphaSearchRequestCrowdingSpec + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec: A struct to // define data stores to filter on in a search call and configurations for // those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -18570,6 +18159,12 @@ func (s GoogleCloudDiscoveryengineV1betaAssistUserMetadata) MarshalJSON() ([]byt type GoogleCloudDiscoveryengineV1betaAssistant struct { // CustomerPolicy: Optional. Customer policy for the assistant. CustomerPolicy *GoogleCloudDiscoveryengineV1betaAssistantCustomerPolicy `json:"customerPolicy,omitempty"` + // Description: Optional. Description for additional information. Expected to + // be shown on the configuration UI, not to the users of the assistant. + Description string `json:"description,omitempty"` + // DisplayName: Required. The assistant display name. It must be a UTF-8 + // encoded string with a length limit of 128 characters. + DisplayName string `json:"displayName,omitempty"` // EnabledTools: Optional. Note: not implemented yet. Use enabled_actions // instead. The enabled tools on this assistant. The keys are connector name, // for example @@ -18871,21 +18466,26 @@ func (s GoogleCloudDiscoveryengineV1betaAssistantCustomerPolicyModelArmorConfig) // GoogleCloudDiscoveryengineV1betaAssistantGenerationConfig: Configuration for // the generation of the assistant response. type GoogleCloudDiscoveryengineV1betaAssistantGenerationConfig struct { + // AllowedModelIds: Optional. The list of models that are allowed to be used + // for assistant. + AllowedModelIds []string `json:"allowedModelIds,omitempty"` // DefaultLanguage: The default language to use for the generation of the // assistant response. Use an ISO 639-1 language code such as `en`. If not // specified, the language will be automatically detected. DefaultLanguage string `json:"defaultLanguage,omitempty"` + // DefaultModelId: Optional. The default model to use for assistant. + DefaultModelId string `json:"defaultModelId,omitempty"` // SystemInstruction: System instruction, also known as the prompt preamble for // LLM calls. See also // https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions SystemInstruction *GoogleCloudDiscoveryengineV1betaAssistantGenerationConfigSystemInstruction `json:"systemInstruction,omitempty"` - // ForceSendFields is a list of field names (e.g. "DefaultLanguage") to + // ForceSendFields is a list of field names (e.g. "AllowedModelIds") to // unconditionally include in API requests. By default, fields with empty or // default values are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more // details. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "DefaultLanguage") to include in + // NullFields is a list of field names (e.g. "AllowedModelIds") to include in // API requests with the JSON null value. By default, fields with empty values // are omitted from API requests. See // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. @@ -24254,6 +23854,36 @@ func (s GoogleCloudDiscoveryengineV1betaLicenseConfigUsageStats) MarshalJSON() ( return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1betaListAssistantsResponse: Response message for +// the AssistantService.ListAssistants method. +type GoogleCloudDiscoveryengineV1betaListAssistantsResponse struct { + // Assistants: All the customer's Assistants. + Assistants []*GoogleCloudDiscoveryengineV1betaAssistant `json:"assistants,omitempty"` + // NextPageToken: A token that can be sent as ListAssistantsRequest.page_token + // to retrieve the next page. If this field is omitted, there are no subsequent + // pages. + NextPageToken string `json:"nextPageToken,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the server. + googleapi.ServerResponse `json:"-"` + // ForceSendFields is a list of field names (e.g. "Assistants") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Assistants") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1betaListAssistantsResponse) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1betaListAssistantsResponse + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1betaListCmekConfigsResponse: Response message // for CmekConfigService.ListCmekConfigs method. type GoogleCloudDiscoveryengineV1betaListCmekConfigsResponse struct { @@ -26690,6 +26320,15 @@ type GoogleCloudDiscoveryengineV1betaSearchRequest struct { // ContentSearchSpec: A specification for configuring the behavior of content // search. ContentSearchSpec *GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec `json:"contentSearchSpec,omitempty"` + // CrowdingSpecs: Optional. Crowding specifications for improving result + // diversity. If multiple CrowdingSpecs are specified, crowding will be + // evaluated on each unique combination of the `field` values, and max_count + // will be the maximum value of `max_count` across all CrowdingSpecs. For + // example, if the first CrowdingSpec has `field` = "color" and `max_count` = + // 3, and the second CrowdingSpec has `field` = "size" and `max_count` = 2, + // then after 3 documents that share the same color AND size have been + // returned, subsequent ones should be removed or demoted. + CrowdingSpecs []*GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec `json:"crowdingSpecs,omitempty"` // DataStoreSpecs: Specifications that define the specific DataStores to be // searched, along with configurations for those data stores. This is only // considered for Engines with multiple data stores. For engines with a single @@ -26756,6 +26395,17 @@ type GoogleCloudDiscoveryengineV1betaSearchRequest struct { // (https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). // If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. OrderBy string `json:"orderBy,omitempty"` + // PageCategories: Optional. The categories associated with a category page. + // Must be set for category navigation queries to achieve good search quality. + // The format should be the same as UserEvent.PageInfo.page_category. This + // field is the equivalent of the query for browse (navigation) queries. It's + // used by the browse model when the query is empty. If the field is empty, it + // will not be used by the browse model. To represent full path of a category, + // use '>' character to separate different hierarchies. If '>' is part of the + // category name, replace it with other character(s). For example, `Graphics + // Cards > RTX>4090 > Founders Edition` where "RTX > 4090" represents one + // level, can be rewritten as `Graphics Cards > RTX_4090 > Founders Edition` + PageCategories []string `json:"pageCategories,omitempty"` // PageSize: Maximum number of Documents to return. The maximum allowed value // depends on the data type. Values above the maximum value are coerced to the // maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * @@ -27487,6 +27137,48 @@ func (s GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpe return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec: Specification for +// crowding. Crowding improves the diversity of search results by limiting the +// number of results that share the same field value. For example, crowding on +// the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will +// return at most 3 results with the same color across all pages. +type GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec struct { + // Field: The field to use for crowding. Documents can be crowded by a field in + // the Document object. Crowding field is case sensitive. + Field string `json:"field,omitempty"` + // MaxCount: The maximum number of documents to keep per value of the field. + // Once there are at least max_count previous results which contain the same + // value for the given field (according to the order specified in `order_by`), + // later results with the same value are "crowded away". If not specified, the + // default value is 1. + MaxCount int64 `json:"maxCount,omitempty"` + // Mode: Mode to use for documents that are crowded away. + // + // Possible values: + // "MODE_UNSPECIFIED" - Unspecified crowding mode. In this case, server + // behavior defaults to Mode.DROP_CROWDED_RESULTS. + // "DROP_CROWDED_RESULTS" - Drop crowded results. + // "DEMOTE_CROWDED_RESULTS_TO_END" - Demote crowded results to the later + // pages. + Mode string `json:"mode,omitempty"` + // ForceSendFields is a list of field names (e.g. "Field") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Field") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudDiscoveryengineV1betaSearchRequestCrowdingSpec + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec: A struct to // define data stores to filter on in a search call and configurations for // those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. @@ -29870,6 +29562,8 @@ type GoogleCloudDiscoveryengineV1betaStreamAssistResponse struct { // AssistToken: A global unique ID that identifies the current pair of request // and stream of responses. Used for feedback and support. AssistToken string `json:"assistToken,omitempty"` + // InvocationTools: The tool names of the tools that were invoked. + InvocationTools []string `json:"invocationTools,omitempty"` // SessionInfo: Session information. Only included in the final // StreamAssistResponse of the response stream. SessionInfo *GoogleCloudDiscoveryengineV1betaStreamAssistResponseSessionInfo `json:"sessionInfo,omitempty"` @@ -30760,8 +30454,8 @@ type GoogleLongrunningListOperationsResponse struct { Operations []*GoogleLongrunningOperation `json:"operations,omitempty"` // Unreachable: Unordered list. Unreachable resources. Populated when the // request sets `ListOperationsRequest.return_partial_success` and reads across - // collections e.g. when attempting to list all resources across all supported - // locations. + // collections. For example, when attempting to list all resources across all + // supported locations. Unreachable []string `json:"unreachable,omitempty"` // ServerResponse contains the HTTP response code and headers from the server. @@ -31194,147 +30888,6 @@ func (s GoogleTypeTimeZone) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } -type MediaDownloadCall struct { - s *Service - name string - urlParams_ gensupport.URLParams - ifNoneMatch_ string - ctx_ context.Context - header_ http.Header -} - -// Download: Downloads a file from the session. -// -// - name: The resource name of the Session. Format: -// `projects/{project}/locations/{location}/collections/{collection}/engines/{ -// engine}/sessions/{session}`. -func (r *MediaService) Download(name string) *MediaDownloadCall { - c := &MediaDownloadCall{s: r.s, urlParams_: make(gensupport.URLParams)} - c.name = name - return c -} - -// FileId sets the optional parameter "fileId": Required. The ID of the file to -// be downloaded. -func (c *MediaDownloadCall) FileId(fileId string) *MediaDownloadCall { - c.urlParams_.Set("fileId", fileId) - return c -} - -// ViewId sets the optional parameter "viewId": The ID of the view to be -// downloaded. -func (c *MediaDownloadCall) ViewId(viewId string) *MediaDownloadCall { - c.urlParams_.Set("viewId", viewId) - return c -} - -// Fields allows partial responses to be retrieved. See -// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more -// details. -func (c *MediaDownloadCall) Fields(s ...googleapi.Field) *MediaDownloadCall { - c.urlParams_.Set("fields", googleapi.CombineFields(s)) - return c -} - -// IfNoneMatch sets an optional parameter which makes the operation fail if the -// object's ETag matches the given value. This is useful for getting updates -// only after the object has changed since the last request. -func (c *MediaDownloadCall) IfNoneMatch(entityTag string) *MediaDownloadCall { - c.ifNoneMatch_ = entityTag - return c -} - -// Context sets the context to be used in this call's Do and Download methods. -func (c *MediaDownloadCall) Context(ctx context.Context) *MediaDownloadCall { - c.ctx_ = ctx - return c -} - -// Header returns a http.Header that can be modified by the caller to add -// headers to the request. -func (c *MediaDownloadCall) Header() http.Header { - if c.header_ == nil { - c.header_ = make(http.Header) - } - return c.header_ -} - -func (c *MediaDownloadCall) doRequest(alt string) (*http.Response, error) { - reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_) - if c.ifNoneMatch_ != "" { - reqHeaders.Set("If-None-Match", c.ifNoneMatch_) - } - c.urlParams_.Set("alt", alt) - c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta/{+name}:downloadFile") - urls += "?" + c.urlParams_.Encode() - req, err := http.NewRequest("GET", urls, nil) - if err != nil { - return nil, err - } - req.Header = reqHeaders - googleapi.Expand(req.URL, map[string]string{ - "name": c.name, - }) - c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "discoveryengine.media.download", "request", internallog.HTTPRequest(req, nil)) - return gensupport.SendRequest(c.ctx_, c.s.client, req) -} - -// Download fetches the API endpoint's "media" value, instead of the normal -// API response value. If the returned error is nil, the Response is guaranteed to -// have a 2xx status code. Callers must close the Response.Body as usual. -func (c *MediaDownloadCall) Download(opts ...googleapi.CallOption) (*http.Response, error) { - gensupport.SetOptions(c.urlParams_, opts...) - res, err := c.doRequest("media") - if err != nil { - return nil, err - } - if err := googleapi.CheckResponse(res); err != nil { - res.Body.Close() - return nil, gensupport.WrapError(err) - } - return res, nil -} - -// Do executes the "discoveryengine.media.download" call. -// Any non-2xx status code is an error. Response headers are in either -// *GdataMedia.ServerResponse.Header or (if a response was returned at all) in -// error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check -// whether the returned error was because http.StatusNotModified was returned. -func (c *MediaDownloadCall) Do(opts ...googleapi.CallOption) (*GdataMedia, error) { - gensupport.SetOptions(c.urlParams_, opts...) - res, err := c.doRequest("json") - if res != nil && res.StatusCode == http.StatusNotModified { - if res.Body != nil { - res.Body.Close() - } - return nil, gensupport.WrapError(&googleapi.Error{ - Code: res.StatusCode, - Header: res.Header, - }) - } - if err != nil { - return nil, err - } - defer googleapi.CloseBody(res) - if err := googleapi.CheckResponse(res); err != nil { - return nil, gensupport.WrapError(err) - } - ret := &GdataMedia{ - ServerResponse: googleapi.ServerResponse{ - Header: res.Header, - HTTPStatusCode: res.StatusCode, - }, - } - target := &ret - b, err := gensupport.DecodeResponseBytes(target, res) - if err != nil { - return nil, err - } - c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "discoveryengine.media.download", "response", internallog.HTTPResponse(res, b)) - return ret, nil -} - type ProjectsProvisionCall struct { s *Service name string @@ -32819,9 +32372,9 @@ func (c *ProjectsLocationsCollectionsDataConnectorOperationsListCall) PageToken( // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsCollectionsDataConnectorOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsCollectionsDataConnectorOperationsListCall { @@ -35206,9 +34759,9 @@ func (c *ProjectsLocationsCollectionsDataStoresBranchesOperationsListCall) PageT // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsCollectionsDataStoresBranchesOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsCollectionsDataStoresBranchesOperationsListCall { @@ -37234,9 +36787,9 @@ func (c *ProjectsLocationsCollectionsDataStoresModelsOperationsListCall) PageTok // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsCollectionsDataStoresModelsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsCollectionsDataStoresModelsOperationsListCall { @@ -37511,9 +37064,9 @@ func (c *ProjectsLocationsCollectionsDataStoresOperationsListCall) PageToken(pag // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsCollectionsDataStoresOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsCollectionsDataStoresOperationsListCall { @@ -38381,9 +37934,9 @@ func (c *ProjectsLocationsCollectionsDataStoresSchemasOperationsListCall) PageTo // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsCollectionsDataStoresSchemasOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsCollectionsDataStoresSchemasOperationsListCall { @@ -40942,9 +40495,9 @@ func (c *ProjectsLocationsCollectionsDataStoresSiteSearchEngineOperationsListCal // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsCollectionsDataStoresSiteSearchEngineOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsCollectionsDataStoresSiteSearchEngineOperationsListCall { @@ -42237,9 +41790,9 @@ func (c *ProjectsLocationsCollectionsDataStoresSiteSearchEngineTargetSitesOperat // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsCollectionsDataStoresSiteSearchEngineTargetSitesOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsCollectionsDataStoresSiteSearchEngineTargetSitesOperationsListCall { @@ -43970,6 +43523,224 @@ func (c *ProjectsLocationsCollectionsEnginesTuneCall) Do(opts ...googleapi.CallO return ret, nil } +type ProjectsLocationsCollectionsEnginesAssistantsCreateCall struct { + s *Service + parent string + googleclouddiscoveryenginev1betaassistant *GoogleCloudDiscoveryengineV1betaAssistant + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// Create: Creates an Assistant. +// +// - parent: The parent resource name. Format: +// `projects/{project}/locations/{location}/collections/{collection}/engines/{ +// engine}`. +func (r *ProjectsLocationsCollectionsEnginesAssistantsService) Create(parent string, googleclouddiscoveryenginev1betaassistant *GoogleCloudDiscoveryengineV1betaAssistant) *ProjectsLocationsCollectionsEnginesAssistantsCreateCall { + c := &ProjectsLocationsCollectionsEnginesAssistantsCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.parent = parent + c.googleclouddiscoveryenginev1betaassistant = googleclouddiscoveryenginev1betaassistant + return c +} + +// AssistantId sets the optional parameter "assistantId": Required. The ID to +// use for the Assistant, which will become the final component of the +// Assistant's resource name. This field must conform to RFC-1034 +// (https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters. +func (c *ProjectsLocationsCollectionsEnginesAssistantsCreateCall) AssistantId(assistantId string) *ProjectsLocationsCollectionsEnginesAssistantsCreateCall { + c.urlParams_.Set("assistantId", assistantId) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more +// details. +func (c *ProjectsLocationsCollectionsEnginesAssistantsCreateCall) Fields(s ...googleapi.Field) *ProjectsLocationsCollectionsEnginesAssistantsCreateCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. +func (c *ProjectsLocationsCollectionsEnginesAssistantsCreateCall) Context(ctx context.Context) *ProjectsLocationsCollectionsEnginesAssistantsCreateCall { + c.ctx_ = ctx + return c +} + +// Header returns a http.Header that can be modified by the caller to add +// headers to the request. +func (c *ProjectsLocationsCollectionsEnginesAssistantsCreateCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsCollectionsEnginesAssistantsCreateCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "application/json", c.header_) + body, err := googleapi.WithoutDataWrapper.JSONBuffer(c.googleclouddiscoveryenginev1betaassistant) + if err != nil { + return nil, err + } + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta/{+parent}/assistants") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "parent": c.parent, + }) + c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.collections.engines.assistants.create", "request", internallog.HTTPRequest(req, body.Bytes())) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "discoveryengine.projects.locations.collections.engines.assistants.create" call. +// Any non-2xx status code is an error. Response headers are in either +// *GoogleCloudDiscoveryengineV1betaAssistant.ServerResponse.Header or (if a +// response was returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsLocationsCollectionsEnginesAssistantsCreateCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDiscoveryengineV1betaAssistant, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleCloudDiscoveryengineV1betaAssistant{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + b, err := gensupport.DecodeResponseBytes(target, res) + if err != nil { + return nil, err + } + c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.collections.engines.assistants.create", "response", internallog.HTTPResponse(res, b)) + return ret, nil +} + +type ProjectsLocationsCollectionsEnginesAssistantsDeleteCall struct { + s *Service + name string + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// Delete: Deletes an Assistant. +// +// - name: Resource name of Assistant. Format: +// `projects/{project}/locations/{location}/collections/{collection}/engines/{ +// engine}/assistants/{assistant}` If the caller does not have permission to +// delete the Assistant, regardless of whether or not it exists, a +// PERMISSION_DENIED error is returned. If the Assistant to delete does not +// exist, a NOT_FOUND error is returned. +func (r *ProjectsLocationsCollectionsEnginesAssistantsService) Delete(name string) *ProjectsLocationsCollectionsEnginesAssistantsDeleteCall { + c := &ProjectsLocationsCollectionsEnginesAssistantsDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more +// details. +func (c *ProjectsLocationsCollectionsEnginesAssistantsDeleteCall) Fields(s ...googleapi.Field) *ProjectsLocationsCollectionsEnginesAssistantsDeleteCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. +func (c *ProjectsLocationsCollectionsEnginesAssistantsDeleteCall) Context(ctx context.Context) *ProjectsLocationsCollectionsEnginesAssistantsDeleteCall { + c.ctx_ = ctx + return c +} + +// Header returns a http.Header that can be modified by the caller to add +// headers to the request. +func (c *ProjectsLocationsCollectionsEnginesAssistantsDeleteCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsCollectionsEnginesAssistantsDeleteCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_) + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta/{+name}") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("DELETE", urls, nil) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.collections.engines.assistants.delete", "request", internallog.HTTPRequest(req, nil)) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "discoveryengine.projects.locations.collections.engines.assistants.delete" call. +// Any non-2xx status code is an error. Response headers are in either +// *GoogleProtobufEmpty.ServerResponse.Header or (if a response was returned at +// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to +// check whether the returned error was because http.StatusNotModified was +// returned. +func (c *ProjectsLocationsCollectionsEnginesAssistantsDeleteCall) Do(opts ...googleapi.CallOption) (*GoogleProtobufEmpty, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleProtobufEmpty{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + b, err := gensupport.DecodeResponseBytes(target, res) + if err != nil { + return nil, err + } + c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.collections.engines.assistants.delete", "response", internallog.HTTPResponse(res, b)) + return ret, nil +} + type ProjectsLocationsCollectionsEnginesAssistantsGetCall struct { s *Service name string @@ -44082,6 +43853,159 @@ func (c *ProjectsLocationsCollectionsEnginesAssistantsGetCall) Do(opts ...google return ret, nil } +type ProjectsLocationsCollectionsEnginesAssistantsListCall struct { + s *Service + parent string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// List: Lists all Assistants under an Engine. +// +// - parent: The parent resource name. Format: +// `projects/{project}/locations/{location}/collections/{collection}/engines/{ +// engine}`. +func (r *ProjectsLocationsCollectionsEnginesAssistantsService) List(parent string) *ProjectsLocationsCollectionsEnginesAssistantsListCall { + c := &ProjectsLocationsCollectionsEnginesAssistantsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.parent = parent + return c +} + +// PageSize sets the optional parameter "pageSize": Maximum number of +// Assistants to return. If unspecified, defaults to 100. The maximum allowed +// value is 1000; anything above that will be coerced down to 1000. +func (c *ProjectsLocationsCollectionsEnginesAssistantsListCall) PageSize(pageSize int64) *ProjectsLocationsCollectionsEnginesAssistantsListCall { + c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) + return c +} + +// PageToken sets the optional parameter "pageToken": A page token +// ListAssistantsResponse.next_page_token, received from a previous +// AssistantService.ListAssistants call. Provide this to retrieve the +// subsequent page. When paginating, all other parameters provided to +// ListAssistants must match the call that provided the page token. +func (c *ProjectsLocationsCollectionsEnginesAssistantsListCall) PageToken(pageToken string) *ProjectsLocationsCollectionsEnginesAssistantsListCall { + c.urlParams_.Set("pageToken", pageToken) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more +// details. +func (c *ProjectsLocationsCollectionsEnginesAssistantsListCall) Fields(s ...googleapi.Field) *ProjectsLocationsCollectionsEnginesAssistantsListCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets an optional parameter which makes the operation fail if the +// object's ETag matches the given value. This is useful for getting updates +// only after the object has changed since the last request. +func (c *ProjectsLocationsCollectionsEnginesAssistantsListCall) IfNoneMatch(entityTag string) *ProjectsLocationsCollectionsEnginesAssistantsListCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. +func (c *ProjectsLocationsCollectionsEnginesAssistantsListCall) Context(ctx context.Context) *ProjectsLocationsCollectionsEnginesAssistantsListCall { + c.ctx_ = ctx + return c +} + +// Header returns a http.Header that can be modified by the caller to add +// headers to the request. +func (c *ProjectsLocationsCollectionsEnginesAssistantsListCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsCollectionsEnginesAssistantsListCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta/{+parent}/assistants") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, nil) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "parent": c.parent, + }) + c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.collections.engines.assistants.list", "request", internallog.HTTPRequest(req, nil)) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "discoveryengine.projects.locations.collections.engines.assistants.list" call. +// Any non-2xx status code is an error. Response headers are in either +// *GoogleCloudDiscoveryengineV1betaListAssistantsResponse.ServerResponse.Header +// +// or (if a response was returned at all) in error.(*googleapi.Error).Header. +// +// Use googleapi.IsNotModified to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsLocationsCollectionsEnginesAssistantsListCall) Do(opts ...googleapi.CallOption) (*GoogleCloudDiscoveryengineV1betaListAssistantsResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleCloudDiscoveryengineV1betaListAssistantsResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + b, err := gensupport.DecodeResponseBytes(target, res) + if err != nil { + return nil, err + } + c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.collections.engines.assistants.list", "response", internallog.HTTPResponse(res, b)) + return ret, nil +} + +// Pages invokes f for each page of results. +// A non-nil error returned from f will halt the iteration. +// The provided context supersedes any context provided to the Context method. +func (c *ProjectsLocationsCollectionsEnginesAssistantsListCall) Pages(ctx context.Context, f func(*GoogleCloudDiscoveryengineV1betaListAssistantsResponse) error) error { + c.ctx_ = ctx + defer c.PageToken(c.urlParams_.Get("pageToken")) + for { + x, err := c.Do() + if err != nil { + return err + } + if err := f(x); err != nil { + return err + } + if x.NextPageToken == "" { + return nil + } + c.PageToken(x.NextPageToken) + } +} + type ProjectsLocationsCollectionsEnginesAssistantsPatchCall struct { s *Service name string @@ -44302,6 +44226,118 @@ func (c *ProjectsLocationsCollectionsEnginesAssistantsStreamAssistCall) Do(opts return ret, nil } +type ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall struct { + s *Service + name string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// 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. +// +// - name: The name of the operation resource. +func (r *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsService) Get(name string) *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall { + c := &ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.name = name + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more +// details. +func (c *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets an optional parameter which makes the operation fail if the +// object's ETag matches the given value. This is useful for getting updates +// only after the object has changed since the last request. +func (c *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. +func (c *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall) Context(ctx context.Context) *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall { + c.ctx_ = ctx + return c +} + +// Header returns a http.Header that can be modified by the caller to add +// headers to the request. +func (c *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := gensupport.SetHeaders(c.s.userAgent(), "", c.header_) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta/{+name}") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, nil) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "name": c.name, + }) + c.s.logger.DebugContext(c.ctx_, "api request", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.collections.engines.assistants.agents.operations.get", "request", internallog.HTTPRequest(req, nil)) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "discoveryengine.projects.locations.collections.engines.assistants.agents.operations.get" call. +// Any non-2xx status code is an error. Response headers are in either +// *GoogleLongrunningOperation.ServerResponse.Header or (if a response was +// returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsLocationsCollectionsEnginesAssistantsAgentsOperationsGetCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &GoogleLongrunningOperation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + b, err := gensupport.DecodeResponseBytes(target, res) + if err != nil { + return nil, err + } + c.s.logger.DebugContext(c.ctx_, "api response", "serviceName", apiName, "rpcName", "discoveryengine.projects.locations.collections.engines.assistants.agents.operations.get", "response", internallog.HTTPResponse(res, b)) + return ret, nil +} + type ProjectsLocationsCollectionsEnginesCompletionConfigCompleteQueryCall struct { s *Service completionConfig string @@ -45993,9 +46029,9 @@ func (c *ProjectsLocationsCollectionsEnginesOperationsListCall) PageToken(pageTo // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsCollectionsEnginesOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsCollectionsEnginesOperationsListCall { @@ -47972,9 +48008,9 @@ func (c *ProjectsLocationsCollectionsOperationsListCall) PageToken(pageToken str // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsCollectionsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsCollectionsOperationsListCall { @@ -50252,9 +50288,9 @@ func (c *ProjectsLocationsDataStoresBranchesOperationsListCall) PageToken(pageTo // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsDataStoresBranchesOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsDataStoresBranchesOperationsListCall { @@ -52167,9 +52203,9 @@ func (c *ProjectsLocationsDataStoresModelsOperationsListCall) PageToken(pageToke // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsDataStoresModelsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsDataStoresModelsOperationsListCall { @@ -52444,9 +52480,9 @@ func (c *ProjectsLocationsDataStoresOperationsListCall) PageToken(pageToken stri // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsDataStoresOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsDataStoresOperationsListCall { @@ -58652,9 +58688,9 @@ func (c *ProjectsLocationsIdentityMappingStoresOperationsListCall) PageToken(pag // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsIdentityMappingStoresOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsIdentityMappingStoresOperationsListCall { @@ -59271,9 +59307,9 @@ func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *Proje // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsOperationsListCall { @@ -62093,16 +62129,22 @@ func (r *ProjectsLocationsUserStoresUserLicensesService) List(parent string) *Pr return c } -// Filter sets the optional parameter "filter": Filter for the list request. -// Supported fields: * `license`_`assignment`_`state` * `user_principal` * -// `user_profile` Examples: * `license`_`assignment`_`state = ASSIGNED` to list -// assigned user licenses. * `license`_`assignment`_`state = NO_LICENSE` to -// list not licensed users. * `license`_`assignment`_`state = -// NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license -// assigned. * `license`_`assignment`_`state != NO_LICENSE_ATTEMPTED_LOGIN` to -// filter out users who attempted login but no license assigned. -func (c *ProjectsLocationsUserStoresUserLicensesListCall) Filter(filter string) *ProjectsLocationsUserStoresUserLicensesListCall { - c.urlParams_.Set("filter", filter) +// OrderBy sets the optional parameter "orderBy": The order in which the +// UserLicenses are listed. The value must be a comma-separated list of fields. +// Default sorting order is ascending. To specify descending order for a field, +// append a " desc" suffix. Redundant space characters in the syntax are +// insignificant. Supported fields: * `license_assignment_state` * +// `user_principal` * `user_profile` * `last_login_date` * `update_time` If not +// set, the default ordering is by `user_principal`. Examples: * +// `user_principal desc` to order by `user_principal` in descending order. * +// `license_assignment_state` to order by `license_assignment_state` in +// ascending order. * `last_login_date desc` to order by `last_login_date` in +// descending order. * `update_time desc` to order by `update_time` in +// descending order. * `last_login_date desc, user_principal` to order by +// `last_login_date` in descending order and then by `user_principal` in +// ascending order. +func (c *ProjectsLocationsUserStoresUserLicensesListCall) OrderBy(orderBy string) *ProjectsLocationsUserStoresUserLicensesListCall { + c.urlParams_.Set("orderBy", orderBy) return c } @@ -62391,9 +62433,9 @@ func (c *ProjectsOperationsListCall) PageToken(pageToken string) *ProjectsOperat // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsOperationsListCall { diff --git a/drive/v2/drive-api.json b/drive/v2/drive-api.json index 01fa932f092..384044b41e2 100644 --- a/drive/v2/drive-api.json +++ b/drive/v2/drive-api.json @@ -3616,7 +3616,7 @@ ] }, "list": { - "description": "Lists a file's revisions.", + "description": "Lists a file's revisions. **Important:** The list of revisions returned by this method might be incomplete for files with a large revision history, including frequently edited Google Docs, Sheets, and Slides. Older revisions might be omitted from the response, meaning the first revision returned may not be the oldest existing revision. The revision history visible in the Workspace editor user interface might be more complete than the list returned by the API.", "flatPath": "files/{fileId}/revisions", "httpMethod": "GET", "id": "drive.revisions.list", @@ -3893,7 +3893,7 @@ } } }, - "revision": "20250829", + "revision": "20251114", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { diff --git a/drive/v2/drive-gen.go b/drive/v2/drive-gen.go index 887165cb295..94c3686ca7c 100644 --- a/drive/v2/drive-gen.go +++ b/drive/v2/drive-gen.go @@ -12336,7 +12336,13 @@ type RevisionsListCall struct { header_ http.Header } -// List: Lists a file's revisions. +// List: Lists a file's revisions. **Important:** The list of revisions +// returned by this method might be incomplete for files with a large revision +// history, including frequently edited Google Docs, Sheets, and Slides. Older +// revisions might be omitted from the response, meaning the first revision +// returned may not be the oldest existing revision. The revision history +// visible in the Workspace editor user interface might be more complete than +// the list returned by the API. // // - fileId: The ID of the file. func (r *RevisionsService) List(fileId string) *RevisionsListCall { diff --git a/drive/v3/drive-api.json b/drive/v3/drive-api.json index 7665bbb4520..34667a9c9e0 100644 --- a/drive/v3/drive-api.json +++ b/drive/v3/drive-api.json @@ -2479,7 +2479,7 @@ "useMediaDownloadService": true }, "list": { - "description": "Lists a file's revisions. For more information, see [Manage file revisions](https://developers.google.com/workspace/drive/api/guides/manage-revisions).", + "description": "Lists a file's revisions. For more information, see [Manage file revisions](https://developers.google.com/workspace/drive/api/guides/manage-revisions). **Important:** The list of revisions returned by this method might be incomplete for files with a large revision history, including frequently edited Google Docs, Sheets, and Slides. Older revisions might be omitted from the response, meaning the first revision returned may not be the oldest existing revision. The revision history visible in the Workspace editor user interface might be more complete than the list returned by the API.", "flatPath": "files/{fileId}/revisions", "httpMethod": "GET", "id": "drive.revisions.list", @@ -2720,7 +2720,7 @@ } } }, - "revision": "20251019", + "revision": "20251114", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -3230,7 +3230,7 @@ "type": "string" }, "assigneeEmailAddress": { - "description": "Output only. The email of the user who is assigned to this comment, if none is assigned this will be unset.", + "description": "Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset.", "readOnly": true, "type": "string" }, @@ -3271,7 +3271,7 @@ "type": "string" }, "mentionedEmailAddresses": { - "description": "Output only. The emails of the users who were mentioned in this comment, if none were mentioned this will be an empty list.", + "description": "Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty.", "items": { "type": "string" }, @@ -4782,7 +4782,7 @@ "type": "string" }, "assigneeEmailAddress": { - "description": "Output only. The email of the user who is assigned to this reply, if none is assigned this will be unset.", + "description": "Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset.", "readOnly": true, "type": "string" }, @@ -4822,7 +4822,7 @@ "type": "string" }, "mentionedEmailAddresses": { - "description": "Output only. The emails of the users who were mentioned in this reply, if none were mentioned this will be an empty list.", + "description": "Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty.", "items": { "type": "string" }, diff --git a/drive/v3/drive-gen.go b/drive/v3/drive-gen.go index 8bc4fa43305..36eb8bfe4b5 100644 --- a/drive/v3/drive-gen.go +++ b/drive/v3/drive-gen.go @@ -849,8 +849,8 @@ type Comment struct { // on defining anchor properties, refer to Manage comments and replies // (https://developers.google.com/workspace/drive/api/v3/manage-comments). Anchor string `json:"anchor,omitempty"` - // AssigneeEmailAddress: Output only. The email of the user who is assigned to - // this comment, if none is assigned this will be unset. + // AssigneeEmailAddress: Output only. The email address of the user assigned to + // this comment. If no user is assigned, the field is unset. AssigneeEmailAddress string `json:"assigneeEmailAddress,omitempty"` // Author: Output only. The author of the comment. The author's email address // and permission ID will not be populated. @@ -870,9 +870,8 @@ type Comment struct { // Kind: Output only. Identifies what kind of resource this is. Value: the // fixed string "drive#comment". Kind string `json:"kind,omitempty"` - // MentionedEmailAddresses: Output only. The emails of the users who were - // mentioned in this comment, if none were mentioned this will be an empty - // list. + // MentionedEmailAddresses: Output only. A list of email addresses for users + // mentioned in this comment. If no users are mentioned, the list is empty. MentionedEmailAddresses []string `json:"mentionedEmailAddresses,omitempty"` // ModifiedTime: The last time the comment or any of its replies was modified // (RFC 3339 date-time). @@ -2670,8 +2669,8 @@ type Reply struct { // Action: The action the reply performed to the parent comment. Valid values // are: * `resolve` * `reopen` Action string `json:"action,omitempty"` - // AssigneeEmailAddress: Output only. The email of the user who is assigned to - // this reply, if none is assigned this will be unset. + // AssigneeEmailAddress: Output only. The email address of the user assigned to + // this comment. If no user is assigned, the field is unset. AssigneeEmailAddress string `json:"assigneeEmailAddress,omitempty"` // Author: Output only. The author of the reply. The author's email address and // permission ID will not be populated. @@ -2692,8 +2691,8 @@ type Reply struct { // Kind: Output only. Identifies what kind of resource this is. Value: the // fixed string "drive#reply". Kind string `json:"kind,omitempty"` - // MentionedEmailAddresses: Output only. The emails of the users who were - // mentioned in this reply, if none were mentioned this will be an empty list. + // MentionedEmailAddresses: Output only. A list of email addresses for users + // mentioned in this comment. If no users are mentioned, the list is empty. MentionedEmailAddresses []string `json:"mentionedEmailAddresses,omitempty"` // ModifiedTime: The last time the reply was modified (RFC 3339 date-time). ModifiedTime string `json:"modifiedTime,omitempty"` @@ -9738,6 +9737,12 @@ type RevisionsListCall struct { // List: Lists a file's revisions. For more information, see Manage file // revisions // (https://developers.google.com/workspace/drive/api/guides/manage-revisions). +// **Important:** The list of revisions returned by this method might be +// incomplete for files with a large revision history, including frequently +// edited Google Docs, Sheets, and Slides. Older revisions might be omitted +// from the response, meaning the first revision returned may not be the oldest +// existing revision. The revision history visible in the Workspace editor user +// interface might be more complete than the list returned by the API. // // - fileId: The ID of the file. func (r *RevisionsService) List(fileId string) *RevisionsListCall { diff --git a/firebaseapphosting/v1beta/firebaseapphosting-api.json b/firebaseapphosting/v1beta/firebaseapphosting-api.json index 0782ddce927..23c0de3d1cf 100644 --- a/firebaseapphosting/v1beta/firebaseapphosting-api.json +++ b/firebaseapphosting/v1beta/firebaseapphosting-api.json @@ -1083,7 +1083,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -1103,7 +1103,7 @@ } } }, - "revision": "20251030", + "revision": "20251113", "rootUrl": "https://firebaseapphosting.googleapis.com/", "schemas": { "ArchiveSource": { @@ -2154,7 +2154,7 @@ "type": "array" }, "unreachable": { - "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, diff --git a/firebaseapphosting/v1beta/firebaseapphosting-gen.go b/firebaseapphosting/v1beta/firebaseapphosting-gen.go index eb5aa0daa7c..e61ffa10b47 100644 --- a/firebaseapphosting/v1beta/firebaseapphosting-gen.go +++ b/firebaseapphosting/v1beta/firebaseapphosting-gen.go @@ -1316,8 +1316,8 @@ type ListOperationsResponse struct { Operations []*Operation `json:"operations,omitempty"` // Unreachable: Unordered list. Unreachable resources. Populated when the // request sets `ListOperationsRequest.return_partial_success` and reads across - // collections e.g. when attempting to list all resources across all supported - // locations. + // collections. For example, when attempting to list all resources across all + // supported locations. Unreachable []string `json:"unreachable,omitempty"` // ServerResponse contains the HTTP response code and headers from the server. @@ -5254,9 +5254,9 @@ func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *Proje // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsOperationsListCall { diff --git a/firebaseml/v2beta/firebaseml-api.json b/firebaseml/v2beta/firebaseml-api.json index 8bda16d13db..cac053fadca 100644 --- a/firebaseml/v2beta/firebaseml-api.json +++ b/firebaseml/v2beta/firebaseml-api.json @@ -206,7 +206,7 @@ } } }, - "revision": "20251116", + "revision": "20251117", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -930,7 +930,7 @@ "type": "string" }, "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.", + "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, colons and dashes, with a maximum length of 64.", "type": "string" }, "parameters": { @@ -2169,6 +2169,22 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ReplicatedVoiceConfig": { + "description": "The configuration for the replicated voice to use.", + "id": "GoogleCloudAiplatformV1beta1ReplicatedVoiceConfig", + "properties": { + "mimeType": { + "description": "Optional. The mimetype of the voice sample. Currently only mime_type=audio/pcm is supported, which is raw mono 16-bit signed little-endian pcm data, with 24k sampling rate.", + "type": "string" + }, + "voiceSampleAudio": { + "description": "Optional. The sample of the custom voice.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1Retrieval": { "description": "Defines a retrieval tool that model can call to access external knowledge.", "id": "GoogleCloudAiplatformV1beta1Retrieval", @@ -2975,6 +2991,10 @@ "prebuiltVoiceConfig": { "$ref": "GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig", "description": "The configuration for a prebuilt voice." + }, + "replicatedVoiceConfig": { + "$ref": "GoogleCloudAiplatformV1beta1ReplicatedVoiceConfig", + "description": "Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample." } }, "type": "object" diff --git a/firebaseml/v2beta/firebaseml-gen.go b/firebaseml/v2beta/firebaseml-gen.go index a461849ba6f..e7d2cdee96d 100644 --- a/firebaseml/v2beta/firebaseml-gen.go +++ b/firebaseml/v2beta/firebaseml-gen.go @@ -1155,8 +1155,8 @@ type GoogleCloudAiplatformV1beta1FunctionDeclaration struct { // it to decide how and whether to call the function. Description string `json:"description,omitempty"` // Name: 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. + // or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots, + // colons and dashes, with a maximum length of 64. Name string `json:"name,omitempty"` // Parameters: Optional. Describes the parameters to this function in JSON // Schema Object format. Reflects the Open API 3.03 Parameter Object. string @@ -2911,6 +2911,33 @@ func (s GoogleCloudAiplatformV1beta1RagRetrievalConfigRankingRankService) Marsha return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudAiplatformV1beta1ReplicatedVoiceConfig: The configuration for the +// replicated voice to use. +type GoogleCloudAiplatformV1beta1ReplicatedVoiceConfig struct { + // MimeType: Optional. The mimetype of the voice sample. Currently only + // mime_type=audio/pcm is supported, which is raw mono 16-bit signed + // little-endian pcm data, with 24k sampling rate. + MimeType string `json:"mimeType,omitempty"` + // VoiceSampleAudio: Optional. The sample of the custom voice. + VoiceSampleAudio string `json:"voiceSampleAudio,omitempty"` + // ForceSendFields is a list of field names (e.g. "MimeType") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "MimeType") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudAiplatformV1beta1ReplicatedVoiceConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudAiplatformV1beta1ReplicatedVoiceConfig + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudAiplatformV1beta1Retrieval: Defines a retrieval tool that model // can call to access external knowledge. type GoogleCloudAiplatformV1beta1Retrieval struct { @@ -3850,6 +3877,9 @@ func (s *GoogleCloudAiplatformV1beta1VideoMetadata) UnmarshalJSON(data []byte) e type GoogleCloudAiplatformV1beta1VoiceConfig struct { // PrebuiltVoiceConfig: The configuration for a prebuilt voice. PrebuiltVoiceConfig *GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig `json:"prebuiltVoiceConfig,omitempty"` + // ReplicatedVoiceConfig: Optional. The configuration for a replicated voice. + // This enables users to replicate a voice from an audio sample. + ReplicatedVoiceConfig *GoogleCloudAiplatformV1beta1ReplicatedVoiceConfig `json:"replicatedVoiceConfig,omitempty"` // ForceSendFields is a list of field names (e.g. "PrebuiltVoiceConfig") to // unconditionally include in API requests. By default, fields with empty or // default values are omitted from API requests. See diff --git a/looker/v1/looker-api.json b/looker/v1/looker-api.json index ab7dba73eae..ec9abafc42d 100644 --- a/looker/v1/looker-api.json +++ b/looker/v1/looker-api.json @@ -695,7 +695,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -715,7 +715,7 @@ } } }, - "revision": "20251021", + "revision": "20251113", "rootUrl": "https://looker.googleapis.com/", "schemas": { "AdminSettings": { @@ -1079,6 +1079,10 @@ "$ref": "OAuthConfig", "description": "Looker instance OAuth login settings." }, + "periodicExportConfig": { + "$ref": "PeriodicExportConfig", + "description": "Optional. Configuration for periodic export." + }, "platformEdition": { "description": "Platform edition.", "enum": [ @@ -1312,7 +1316,7 @@ "type": "array" }, "unreachable": { - "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, @@ -1494,6 +1498,25 @@ }, "type": "object" }, + "PeriodicExportConfig": { + "description": "Configuration for periodic export.", + "id": "PeriodicExportConfig", + "properties": { + "gcsUri": { + "description": "Required. Cloud Storage bucket URI for periodic export. Format: gs://{bucket_name}", + "type": "string" + }, + "kmsKey": { + "description": "Required. Name of the CMEK key in KMS. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}", + "type": "string" + }, + "startTime": { + "$ref": "TimeOfDay", + "description": "Required. Time in UTC to start the periodic export job." + } + }, + "type": "object" + }, "PscConfig": { "description": "Information for Private Service Connect (PSC) setup for a Looker instance.", "id": "PscConfig", diff --git a/looker/v1/looker-gen.go b/looker/v1/looker-gen.go index adef8ea1411..491fec20975 100644 --- a/looker/v1/looker-gen.go +++ b/looker/v1/looker-gen.go @@ -608,6 +608,8 @@ type Instance struct { Name string `json:"name,omitempty"` // OauthConfig: Looker instance OAuth login settings. OauthConfig *OAuthConfig `json:"oauthConfig,omitempty"` + // PeriodicExportConfig: Optional. Configuration for periodic export. + PeriodicExportConfig *PeriodicExportConfig `json:"periodicExportConfig,omitempty"` // PlatformEdition: Platform edition. // // Possible values: @@ -823,8 +825,8 @@ type ListOperationsResponse struct { Operations []*Operation `json:"operations,omitempty"` // Unreachable: Unordered list. Unreachable resources. Populated when the // request sets `ListOperationsRequest.return_partial_success` and reads across - // collections e.g. when attempting to list all resources across all supported - // locations. + // collections. For example, when attempting to list all resources across all + // supported locations. Unreachable []string `json:"unreachable,omitempty"` // ServerResponse contains the HTTP response code and headers from the server. @@ -1054,6 +1056,35 @@ func (s OperationMetadata) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// PeriodicExportConfig: Configuration for periodic export. +type PeriodicExportConfig struct { + // GcsUri: Required. Cloud Storage bucket URI for periodic export. Format: + // gs://{bucket_name} + GcsUri string `json:"gcsUri,omitempty"` + // KmsKey: Required. Name of the CMEK key in KMS. Format: + // projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypt + // o_key} + KmsKey string `json:"kmsKey,omitempty"` + // StartTime: Required. Time in UTC to start the periodic export job. + StartTime *TimeOfDay `json:"startTime,omitempty"` + // ForceSendFields is a list of field names (e.g. "GcsUri") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "GcsUri") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s PeriodicExportConfig) MarshalJSON() ([]byte, error) { + type NoMethod PeriodicExportConfig + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // PscConfig: Information for Private Service Connect (PSC) setup for a Looker // instance. type PscConfig struct { @@ -3364,9 +3395,9 @@ func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *Proje // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsOperationsListCall { diff --git a/managedkafka/v1/managedkafka-api.json b/managedkafka/v1/managedkafka-api.json index 9af60e1a962..3190dae7828 100644 --- a/managedkafka/v1/managedkafka-api.json +++ b/managedkafka/v1/managedkafka-api.json @@ -1639,7 +1639,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -3151,7 +3151,7 @@ } } }, - "revision": "20251030", + "revision": "20251114", "rootUrl": "https://managedkafka.googleapis.com/", "schemas": { "AccessConfig": { @@ -3917,7 +3917,7 @@ "type": "array" }, "unreachable": { - "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, diff --git a/managedkafka/v1/managedkafka-gen.go b/managedkafka/v1/managedkafka-gen.go index 133fdf64f5c..00160a6d8f9 100644 --- a/managedkafka/v1/managedkafka-gen.go +++ b/managedkafka/v1/managedkafka-gen.go @@ -1530,8 +1530,8 @@ type ListOperationsResponse struct { Operations []*Operation `json:"operations,omitempty"` // Unreachable: Unordered list. Unreachable resources. Populated when the // request sets `ListOperationsRequest.return_partial_success` and reads across - // collections e.g. when attempting to list all resources across all supported - // locations. + // collections. For example, when attempting to list all resources across all + // supported locations. Unreachable []string `json:"unreachable,omitempty"` // ServerResponse contains the HTTP response code and headers from the server. @@ -7225,9 +7225,9 @@ func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *Proje // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsOperationsListCall { diff --git a/observability/v1/observability-api.json b/observability/v1/observability-api.json index 5e40c622a59..68409b5c557 100644 --- a/observability/v1/observability-api.json +++ b/observability/v1/observability-api.json @@ -296,7 +296,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -536,7 +536,7 @@ } } }, - "revision": "20251023", + "revision": "20251113", "rootUrl": "https://observability.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -585,7 +585,7 @@ "type": "array" }, "unreachable": { - "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, diff --git a/observability/v1/observability-gen.go b/observability/v1/observability-gen.go index 43147949a1c..d6d757d3cf0 100644 --- a/observability/v1/observability-gen.go +++ b/observability/v1/observability-gen.go @@ -261,8 +261,8 @@ type ListOperationsResponse struct { Operations []*Operation `json:"operations,omitempty"` // Unreachable: Unordered list. Unreachable resources. Populated when the // request sets `ListOperationsRequest.return_partial_success` and reads across - // collections e.g. when attempting to list all resources across all supported - // locations. + // collections. For example, when attempting to list all resources across all + // supported locations. Unreachable []string `json:"unreachable,omitempty"` // ServerResponse contains the HTTP response code and headers from the server. @@ -1184,9 +1184,9 @@ func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *Proje // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsOperationsListCall { diff --git a/oracledatabase/v1/oracledatabase-api.json b/oracledatabase/v1/oracledatabase-api.json index 3b3371ecef5..76ae6da82e6 100644 --- a/oracledatabase/v1/oracledatabase-api.json +++ b/oracledatabase/v1/oracledatabase-api.json @@ -2382,7 +2382,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -2472,7 +2472,7 @@ } } }, - "revision": "20251022", + "revision": "20251117", "rootUrl": "https://oracledatabase.googleapis.com/", "schemas": { "AllConnectionStrings": { @@ -6299,7 +6299,7 @@ "type": "array" }, "unreachable": { - "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, diff --git a/oracledatabase/v1/oracledatabase-gen.go b/oracledatabase/v1/oracledatabase-gen.go index d93df6c5df2..1a4d41747d7 100644 --- a/oracledatabase/v1/oracledatabase-gen.go +++ b/oracledatabase/v1/oracledatabase-gen.go @@ -4047,8 +4047,8 @@ type ListOperationsResponse struct { Operations []*Operation `json:"operations,omitempty"` // Unreachable: Unordered list. Unreachable resources. Populated when the // request sets `ListOperationsRequest.return_partial_success` and reads across - // collections e.g. when attempting to list all resources across all supported - // locations. + // collections. For example, when attempting to list all resources across all + // supported locations. Unreachable []string `json:"unreachable,omitempty"` // ServerResponse contains the HTTP response code and headers from the server. @@ -13041,9 +13041,9 @@ func (c *ProjectsLocationsOperationsListCall) PageToken(pageToken string) *Proje // ReturnPartialSuccess sets the optional parameter "returnPartialSuccess": // When set to `true`, operations that are reachable are returned as normal, // and those that are unreachable are returned in the -// [ListOperationsResponse.unreachable] field. This can only be `true` when -// reading across collections e.g. when `parent` is set to -// "projects/example/locations/-". This field is not by default supported and +// ListOperationsResponse.unreachable field. This can only be `true` when +// reading across collections. For example, when `parent` is set to +// "projects/example/locations/-". This field is not supported by default and // will result in an `UNIMPLEMENTED` error if set unless explicitly documented // otherwise in service or product specific documentation. func (c *ProjectsLocationsOperationsListCall) ReturnPartialSuccess(returnPartialSuccess bool) *ProjectsLocationsOperationsListCall { diff --git a/people/v1/people-api.json b/people/v1/people-api.json index c6ac578dda3..19a849f6ed4 100644 --- a/people/v1/people-api.json +++ b/people/v1/people-api.json @@ -12,7 +12,7 @@ "description": "See and download your contacts" }, "https://www.googleapis.com/auth/directory.readonly": { - "description": "See and download your organization's GSuite directory" + "description": "See and download your organization's Google Workspace directory" }, "https://www.googleapis.com/auth/user.addresses.read": { "description": "View your street addresses" @@ -1190,7 +1190,7 @@ } } }, - "revision": "20250513", + "revision": "20251117", "rootUrl": "https://people.googleapis.com/", "schemas": { "Address": { diff --git a/people/v1/people-gen.go b/people/v1/people-gen.go index e619f45cb39..f0624ffdd18 100644 --- a/people/v1/people-gen.go +++ b/people/v1/people-gen.go @@ -112,7 +112,7 @@ const ( // See and download your contacts ContactsReadonlyScope = "https://www.googleapis.com/auth/contacts.readonly" - // See and download your organization's GSuite directory + // See and download your organization's Google Workspace directory DirectoryReadonlyScope = "https://www.googleapis.com/auth/directory.readonly" // View your street addresses diff --git a/searchads360/v0/searchads360-api.json b/searchads360/v0/searchads360-api.json index fd55c88121b..4738c0f6eef 100644 --- a/searchads360/v0/searchads360-api.json +++ b/searchads360/v0/searchads360-api.json @@ -260,7 +260,7 @@ } } }, - "revision": "20250721", + "revision": "20251116", "rootUrl": "https://searchads360.googleapis.com/", "schemas": { "GoogleAdsSearchads360V0Common__AdScheduleInfo": { @@ -627,6 +627,33 @@ "properties": {}, "type": "object" }, + "GoogleAdsSearchads360V0Common__FinalAppUrl": { + "description": "A URL for deep linking into an app for the given operating system.", + "id": "GoogleAdsSearchads360V0Common__FinalAppUrl", + "properties": { + "osType": { + "description": "The operating system targeted by this URL. Required.", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "IOS", + "ANDROID" + ], + "enumDescriptions": [ + "Not specified.", + "Used for return value only. Represents value unknown in this version.", + "The Apple IOS operating system.", + "The Android operating system." + ], + "type": "string" + }, + "url": { + "description": "The app deep link URL. Deep links specify a location in an app that corresponds to the content you'd like to show, and should be of the form {scheme}://{host_path} The scheme identifies which app to open. For your app, you can use a custom scheme that starts with the app's name. The host and path specify the unique location in the app where your content exists. Example: \"exampleapp://productid_1234\". Required.", + "type": "string" + } + }, + "type": "object" + }, "GoogleAdsSearchads360V0Common__FrequencyCapEntry": { "description": "A rule specifying the maximum number of times an ad (or some set of ads) can be shown to a user over a particular time period.", "id": "GoogleAdsSearchads360V0Common__FrequencyCapEntry", @@ -1010,6 +1037,11 @@ "format": "double", "type": "number" }, + "averageCartSize": { + "description": "Average cart size is the average number of products in each order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average cart size is the total number of products sold divided by the total number of orders you received. Example: You received 2 orders, the first included 3 products and the second included 2. The average cart size is 2.5 products = (3+2)/2. This metric is only available if you report conversions with cart data.", + "format": "double", + "type": "number" + }, "averageCost": { "description": "The average amount you pay per interaction. This amount is the total cost of your ads divided by the total number of interactions.", "format": "double", @@ -1025,6 +1057,16 @@ "format": "double", "type": "number" }, + "averageImpressionFrequencyPerUser": { + "description": "The average number of times a unique user saw your ad during the requested time period. This metric cannot be aggregated, and can only be requested for date ranges of 92 days or less. This metric is available for following campaign types - Display, Video, Discovery and App.", + "format": "double", + "type": "number" + }, + "averageOrderValueMicros": { + "description": "Average order value is the average revenue you made per order attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Average order value is the total revenue from your orders divided by the total number of orders. Example: You received 3 orders which made $10, $15 and $20 worth of revenue. The average order value is $15 = ($10 + $15 + $20)/3. This metric is only available if you report conversions with cart data.", + "format": "int64", + "type": "string" + }, "averageQualityScore": { "description": "The average quality score.", "format": "double", @@ -1152,6 +1194,11 @@ "format": "int64", "type": "string" }, + "costOfGoodsSoldMicros": { + "description": "Cost of goods sold (COGS) is the total cost of the products you sold in orders attributed to your ads. How it works: You can add a cost of goods sold value to every product in Merchant Center. If you report conversions with cart data, the products you sold are matched with their cost of goods sold value and this can be used to calculate the gross profit you made on each order. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cost of goods sold for this order is $8 = $3 + $5. This metric is only available if you report conversions with cart data.", + "format": "int64", + "type": "string" + }, "costPerAllConversions": { "description": "The cost of ad interactions divided by all conversions.", "format": "double", @@ -1222,6 +1269,16 @@ "format": "int64", "type": "string" }, + "grossProfitMargin": { + "description": "Gross profit margin is the percentage gross profit you made from orders attributed to your ads, after taking out the cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. Gross profit margin is the gross profit you made divided by your total revenue and multiplied by 100%. Gross profit margin calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone bought a hat and a shirt in an order on your website. The hat is priced $10 and has a cost of goods sold value of $3. The shirt is priced $20 but has no cost of goods sold value. Gross profit margin for this order will only take into account the hat because it has a cost of goods sold value, so it's 70% = ($10 - $3)/$10 x 100%. This metric is only available if you report conversions with cart data.", + "format": "double", + "type": "number" + }, + "grossProfitMicros": { + "description": "Gross profit is the profit you made from orders attributed to your ads minus the cost of goods sold (COGS). How it works: Gross profit is the revenue you made from sales attributed to your ads minus cost of goods sold. Gross profit calculations only include products that have a cost of goods sold value in Merchant Center. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order from your website. The hat is priced $10 and the shirt is priced $20. The hat has a cost of goods sold value of $3, but the shirt has no cost of goods sold value. Gross profit for this order will only take into account the hat, so it's $7 = $10 - $3. This metric is only available if you report conversions with cart data.", + "format": "int64", + "type": "string" + }, "historicalCreativeQualityScore": { "description": "The creative historical quality score.", "enum": [ @@ -1354,6 +1411,11 @@ "format": "double", "type": "number" }, + "orders": { + "description": "Orders is the total number of purchase conversions you received attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. If a conversion is attributed to previous interactions with your ads (clicks for text or Shopping ads, views for video ads etc.) it's counted as an order. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order on your website. Even though they bought 2 products, this would count as 1 order. This metric is only available if you report conversions with cart data.", + "format": "double", + "type": "number" + }, "rawEventConversionMetrics": { "description": "The raw event conversion metrics.", "items": { @@ -1361,6 +1423,11 @@ }, "type": "array" }, + "revenueMicros": { + "description": "Revenue is the total amount you made from orders attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Revenue is the total value of all the orders you received attributed to your ads, minus any discount. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt in an order from your website. The hat is priced $10 and the shirt is priced $20. The entire order has a $5 discount. The revenue from this order is $25 = ($10 + $20) - $5. This metric is only available if you report conversions with cart data.", + "format": "int64", + "type": "string" + }, "searchAbsoluteTopImpressionShare": { "description": "The percentage of the customer's Shopping or Search ad impressions that are shown in the most prominent Shopping position. See https://support.google.com/sa360/answer/9566729 for details. Any value below 0.1 is reported as 0.0999.", "format": "double", @@ -1421,6 +1488,16 @@ "format": "double", "type": "number" }, + "uniqueUsers": { + "description": "The number of unique users who saw your ad during the requested time period. This metric cannot be aggregated, and can only be requested for date ranges of 92 days or less. This metric is available for following campaign types - Display, Video, Discovery and App.", + "format": "int64", + "type": "string" + }, + "unitsSold": { + "description": "Units sold is the total number of products sold from orders attributed to your ads. How it works: You report conversions with cart data for completed purchases on your website. Units sold is the total number of products sold from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The units sold in this order is 3. This metric is only available if you report conversions with cart data.", + "format": "double", + "type": "number" + }, "valuePerAllConversions": { "description": "The value of all conversions divided by the number of all conversions.", "format": "double", @@ -3929,6 +4006,24 @@ "$ref": "GoogleAdsSearchads360V0Common__SearchAds360ExpandedTextAdInfo", "description": "Immutable. Details pertaining to an expanded text ad." }, + "finalAppUrls": { + "description": "A list of final app URLs that will be used on mobile if the user has the specific app installed.", + "items": { + "$ref": "GoogleAdsSearchads360V0Common__FinalAppUrl" + }, + "type": "array" + }, + "finalMobileUrls": { + "description": "The list of possible final mobile URLs after all cross-domain redirects for the ad.", + "items": { + "type": "string" + }, + "type": "array" + }, + "finalUrlSuffix": { + "description": "The suffix to use when constructing a final URL.", + "type": "string" + }, "finalUrls": { "description": "The list of possible final URLs after all cross-domain redirects for the ad.", "items": { @@ -3962,6 +4057,10 @@ "$ref": "GoogleAdsSearchads360V0Common__SearchAds360TextAdInfo", "description": "Immutable. Details pertaining to a text ad." }, + "trackingUrlTemplate": { + "description": "The URL template for constructing a tracking URL.", + "type": "string" + }, "type": { "description": "Output only. The type of ad.", "enum": [ @@ -4136,6 +4235,10 @@ "readOnly": true, "type": "string" }, + "finalUrlSuffix": { + "description": "URL template for appending params to Final URL.", + "type": "string" + }, "id": { "description": "Output only. The ID of the ad group.", "format": "int64", @@ -4195,6 +4298,10 @@ "$ref": "GoogleAdsSearchads360V0Common__TargetingSetting", "description": "Setting for targeting related features." }, + "trackingUrlTemplate": { + "description": "The URL template for constructing a tracking URL.", + "type": "string" + }, "type": { "description": "Immutable. The type of the ad group.", "enum": [ @@ -4397,7 +4504,7 @@ "type": "string" }, "resourceName": { - "description": "Immutable. The resource name of the ad group ad effective label. Ad group ad effective label resource names have the form: `customers/{customer_id}/adGroupAdEffectiveLabels/{ad_group_id}~{ad_id}~{label_id}`", + "description": "Immutable. The resource name of the ad group ad effective label. Ad group ad effective label resource names have the form: `customers/{owner_customer_id}/adGroupAdEffectiveLabels/{ad_group_id}~{ad_id}~{label_id}`", "type": "string" } }, @@ -4422,7 +4529,7 @@ "type": "string" }, "resourceName": { - "description": "Immutable. The resource name of the ad group ad label. Ad group ad label resource names have the form: `customers/{customer_id}/adGroupAdLabels/{ad_group_id}~{ad_id}~{label_id}`", + "description": "Immutable. The resource name of the ad group ad label. Ad group ad label resource names have the form: `customers/{owner_customer_id}/adGroupAdLabels/{ad_group_id}~{ad_id}~{label_id}`", "type": "string" } }, @@ -4659,6 +4766,13 @@ "readOnly": true, "type": "string" }, + "finalMobileUrls": { + "description": "The list of possible final mobile URLs after all cross-domain redirects.", + "items": { + "type": "string" + }, + "type": "array" + }, "finalUrlSuffix": { "description": "URL template for appending params to final URL.", "type": "string" @@ -4828,6 +4942,13 @@ "readOnly": true, "type": "string" }, + "urlCustomParameters": { + "description": "The list of mappings used to substitute custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.", + "items": { + "$ref": "GoogleAdsSearchads360V0Common__CustomParameter" + }, + "type": "array" + }, "userList": { "$ref": "GoogleAdsSearchads360V0Common__UserListInfo", "description": "Immutable. User List." @@ -4858,7 +4979,7 @@ "type": "string" }, "resourceName": { - "description": "Immutable. The resource name of the ad group criterion effective label. Ad group criterion effective label resource names have the form: `customers/{customer_id}/adGroupCriterionEffectiveLabels/{ad_group_id}~{criterion_id}~{label_id}`", + "description": "Immutable. The resource name of the ad group criterion effective label. Ad group criterion effective label resource names have the form: `customers/{owner_customer_id}/adGroupCriterionEffectiveLabels/{ad_group_id}~{criterion_id}~{label_id}`", "type": "string" } }, @@ -4883,7 +5004,7 @@ "type": "string" }, "resourceName": { - "description": "Immutable. The resource name of the ad group criterion label. Ad group criterion label resource names have the form: `customers/{customer_id}/adGroupCriterionLabels/{ad_group_id}~{criterion_id}~{label_id}`", + "description": "Immutable. The resource name of the ad group criterion label. Ad group criterion label resource names have the form: `customers/{owner_customer_id}/adGroupCriterionLabels/{ad_group_id}~{criterion_id}~{label_id}`", "type": "string" } }, @@ -4908,7 +5029,7 @@ "type": "string" }, "resourceName": { - "description": "Immutable. The resource name of the ad group effective label. Ad group effective label resource names have the form: `customers/{customer_id}/adGroupEffectiveLabels/{ad_group_id}~{label_id}`", + "description": "Immutable. The resource name of the ad group effective label. Ad group effective label resource names have the form: `customers/{owner_customer_id}/adGroupEffectiveLabels/{ad_group_id}~{label_id}`", "type": "string" } }, @@ -4933,7 +5054,7 @@ "type": "string" }, "resourceName": { - "description": "Immutable. The resource name of the ad group label. Ad group label resource names have the form: `customers/{customer_id}/adGroupLabels/{ad_group_id}~{label_id}`", + "description": "Immutable. The resource name of the ad group label. Ad group label resource names have the form: `customers/{owner_customer_id}/adGroupLabels/{ad_group_id}~{label_id}`", "type": "string" } }, @@ -4997,6 +5118,17 @@ "readOnly": true, "type": "string" }, + "finalMobileUrls": { + "description": "A list of possible final mobile URLs after all cross domain redirects.", + "items": { + "type": "string" + }, + "type": "array" + }, + "finalUrlSuffix": { + "description": "URL template for appending params to landing page URLs served with parallel tracking.", + "type": "string" + }, "finalUrls": { "description": "A list of possible final URLs after all cross domain redirects.", "items": { @@ -5144,6 +5276,13 @@ "readOnly": true, "type": "string" }, + "urlCustomParameters": { + "description": "A list of mappings to be used for substituting URL custom parameter tags in the tracking_url_template, final_urls, and/or final_mobile_urls.", + "items": { + "$ref": "GoogleAdsSearchads360V0Common__CustomParameter" + }, + "type": "array" + }, "youtubeVideoAsset": { "$ref": "GoogleAdsSearchads360V0Common__YoutubeVideoAsset", "description": "Immutable. A YouTube video asset." @@ -5285,7 +5424,9 @@ "AD_IMAGE", "BUSINESS_LOGO", "HOTEL_PROPERTY", - "DISCOVERY_CAROUSEL_CARD" + "DISCOVERY_CAROUSEL_CARD", + "LONG_DESCRIPTION", + "CALL_TO_ACTION" ], "enumDescriptions": [ "Not specified.", @@ -5317,7 +5458,9 @@ "The asset is linked for use to select an ad image.", "The asset is linked for use as a business logo.", "The asset is linked for use as a hotel property in a Performance Max for travel goals campaign.", - "The asset is linked for use as a discovery carousel card." + "The asset is linked for use as a discovery carousel card.", + "The asset is linked for use as a long description.", + "The asset is linked for use as a call-to-action." ], "type": "string" }, @@ -5985,7 +6128,9 @@ "AD_IMAGE", "BUSINESS_LOGO", "HOTEL_PROPERTY", - "DISCOVERY_CAROUSEL_CARD" + "DISCOVERY_CAROUSEL_CARD", + "LONG_DESCRIPTION", + "CALL_TO_ACTION" ], "enumDescriptions": [ "Not specified.", @@ -6017,12 +6162,62 @@ "The asset is linked for use to select an ad image.", "The asset is linked for use as a business logo.", "The asset is linked for use as a hotel property in a Performance Max for travel goals campaign.", - "The asset is linked for use as a discovery carousel card." + "The asset is linked for use as a discovery carousel card.", + "The asset is linked for use as a long description.", + "The asset is linked for use as a call-to-action." ], "type": "string" }, "type": "array" }, + "feedTypes": { + "description": "Output only. Types of feeds that are attached directly to this campaign.", + "items": { + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "PAGE_FEED", + "DYNAMIC_EDUCATION", + "MERCHANT_CENTER_FEED", + "DYNAMIC_REAL_ESTATE", + "DYNAMIC_CUSTOM", + "DYNAMIC_HOTELS_AND_RENTALS", + "DYNAMIC_FLIGHTS", + "DYNAMIC_TRAVEL", + "DYNAMIC_LOCAL", + "DYNAMIC_JOBS", + "LOCATION_SYNC", + "BUSINESS_PROFILE_DYNAMIC_LOCATION_GROUP", + "CHAIN_DYNAMIC_LOCATION_GROUP", + "STATIC_LOCATION_GROUP", + "HOTEL_PROPERTY", + "TRAVEL_FEED" + ], + "enumDescriptions": [ + "Not specified.", + "Used for return value only. Represents value unknown in this version.", + "Page asset set.", + "Dynamic education asset set.", + "Google Merchant Center asset set.", + "Dynamic real estate asset set.", + "Dynamic custom asset set.", + "Dynamic hotels and rentals asset set.", + "Dynamic flights asset set.", + "Dynamic travel asset set.", + "Dynamic local asset set.", + "Dynamic jobs asset set.", + "Location sync level asset set.", + "Business Profile location group asset set.", + "Chain location group asset set which can be used for both owned locations and affiliate locations.", + "Static location group asset set which can be used for both owned locations and affiliate locations.", + "Hotel Property asset set which is used to link a hotel property feed to Performance Max for travel goals campaigns.", + "Travel Feed asset set type. Can represent either a Hotel feed or a Things to Do (activities) feed." + ], + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "finalUrlSuffix": { "description": "Suffix used to append query parameters to landing pages that are served with parallel tracking.", "type": "string" @@ -6531,7 +6726,7 @@ "type": "string" }, "resourceName": { - "description": "Immutable. Name of the resource. CampaignEffectivelabel resource names have the form: `customers/{customer_id}/campaignEffectiveLabels/{campaign_id}~{label_id}`", + "description": "Immutable. Name of the resource. CampaignEffectivelabel resource names have the form: `customers/{owner_customer_id}/campaignEffectiveLabels/{campaign_id}~{label_id}`", "type": "string" } }, @@ -6556,7 +6751,7 @@ "type": "string" }, "resourceName": { - "description": "Immutable. Name of the resource. Campaign label resource names have the form: `customers/{customer_id}/campaignLabels/{campaign_id}~{label_id}`", + "description": "Immutable. Name of the resource. Campaign label resource names have the form: `customers/{owner_customer_id}/campaignLabels/{campaign_id}~{label_id}`", "type": "string" } }, @@ -6621,7 +6816,9 @@ "AD_IMAGE", "BUSINESS_LOGO", "HOTEL_PROPERTY", - "DISCOVERY_CAROUSEL_CARD" + "DISCOVERY_CAROUSEL_CARD", + "LONG_DESCRIPTION", + "CALL_TO_ACTION" ], "enumDescriptions": [ "Not specified.", @@ -6653,7 +6850,9 @@ "The asset is linked for use to select an ad image.", "The asset is linked for use as a business logo.", "The asset is linked for use as a hotel property in a Performance Max for travel goals campaign.", - "The asset is linked for use as a discovery carousel card." + "The asset is linked for use as a discovery carousel card.", + "The asset is linked for use as a long description.", + "The asset is linked for use as a call-to-action." ], "readOnly": true, "type": "string" @@ -7897,7 +8096,7 @@ "type": "string" }, "resourceName": { - "description": "Immutable. Name of the resource. Label resource names have the form: `customers/{customer_id}/labels/{label_id}`", + "description": "Immutable. Name of the resource. Label resource names have the form: `customers/{owner_customer_id}/labels/{label_id}`", "type": "string" }, "status": { @@ -8248,7 +8447,7 @@ "type": "object" }, "GoogleAdsSearchads360V0Resources__ShoppingPerformanceView": { - "description": "Shopping performance view. Provides Shopping campaign statistics aggregated at several product dimension levels. Product dimension values from Merchant Center such as brand, category, custom attributes, product condition and product type will reflect the state of each dimension as of the date and time when the corresponding event was recorded.", + "description": "Shopping performance view. Provides Shopping campaign statistics aggregated at several product dimension levels. Product dimension values from Merchant Center such as brand, category, custom attributes, product condition and product type will reflect the state of each dimension as of the date and time when the corresponding event was recorded. The number of impressions and clicks that shopping_performance_view returns stats for may be different from campaign reports. shopping_performance_view shows impressions and clicks on products appearing in ads, while campaign reports show impressions and clicks on the ads themselves. Depending on the format, an ad can show from zero to several products, so the numbers may not match. In Google Ads UI, you can query impressions and clicks of products appearing in ads by selecting a column from \"Product attributes\" in the report editor. For example, selecting the \"Brand\" column is equivalent to selecting `segments.product_brand`.", "id": "GoogleAdsSearchads360V0Resources__ShoppingPerformanceView", "properties": { "resourceName": { @@ -8370,7 +8569,9 @@ "AD_IMAGE", "BUSINESS_LOGO", "HOTEL_PROPERTY", - "DISCOVERY_CAROUSEL_CARD" + "DISCOVERY_CAROUSEL_CARD", + "LONG_DESCRIPTION", + "CALL_TO_ACTION" ], "enumDescriptions": [ "Not specified.", @@ -8402,7 +8603,9 @@ "The asset is linked for use to select an ad image.", "The asset is linked for use as a business logo.", "The asset is linked for use as a hotel property in a Performance Max for travel goals campaign.", - "The asset is linked for use as a discovery carousel card." + "The asset is linked for use as a discovery carousel card.", + "The asset is linked for use as a long description.", + "The asset is linked for use as a call-to-action." ], "readOnly": true, "type": "string" diff --git a/searchads360/v0/searchads360-gen.go b/searchads360/v0/searchads360-gen.go index 866e6b987fd..89ca73a2f71 100644 --- a/searchads360/v0/searchads360-gen.go +++ b/searchads360/v0/searchads360-gen.go @@ -582,6 +582,43 @@ func (s GoogleAdsSearchads360V0Common__DeviceInfo) MarshalJSON() ([]byte, error) type GoogleAdsSearchads360V0Common__EnhancedCpc struct { } +// GoogleAdsSearchads360V0Common__FinalAppUrl: A URL for deep linking into an +// app for the given operating system. +type GoogleAdsSearchads360V0Common__FinalAppUrl struct { + // OsType: The operating system targeted by this URL. Required. + // + // Possible values: + // "UNSPECIFIED" - Not specified. + // "UNKNOWN" - Used for return value only. Represents value unknown in this + // version. + // "IOS" - The Apple IOS operating system. + // "ANDROID" - The Android operating system. + OsType string `json:"osType,omitempty"` + // Url: The app deep link URL. Deep links specify a location in an app that + // corresponds to the content you'd like to show, and should be of the form + // {scheme}://{host_path} The scheme identifies which app to open. For your + // app, you can use a custom scheme that starts with the app's name. The host + // and path specify the unique location in the app where your content exists. + // Example: "exampleapp://productid_1234". Required. + Url string `json:"url,omitempty"` + // ForceSendFields is a list of field names (e.g. "OsType") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "OsType") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleAdsSearchads360V0Common__FinalAppUrl) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0Common__FinalAppUrl + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleAdsSearchads360V0Common__FrequencyCapEntry: A rule specifying the // maximum number of times an ad (or some set of ads) can be shown to a user // over a particular time period. @@ -1045,6 +1082,14 @@ type GoogleAdsSearchads360V0Common__Metrics struct { // total cost of ad interactions (such as clicks for text ads or views for // video ads). AllConversionsValuePerCost float64 `json:"allConversionsValuePerCost,omitempty"` + // AverageCartSize: Average cart size is the average number of products in each + // order attributed to your ads. How it works: You report conversions with cart + // data for completed purchases on your website. Average cart size is the total + // number of products sold divided by the total number of orders you received. + // Example: You received 2 orders, the first included 3 products and the second + // included 2. The average cart size is 2.5 products = (3+2)/2. This metric is + // only available if you report conversions with cart data. + AverageCartSize float64 `json:"averageCartSize,omitempty"` // AverageCost: The average amount you pay per interaction. This amount is the // total cost of your ads divided by the total number of interactions. AverageCost float64 `json:"averageCost,omitempty"` @@ -1058,6 +1103,20 @@ type GoogleAdsSearchads360V0Common__Metrics struct { // metrics_currency parameter at // https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause AverageCpm float64 `json:"averageCpm,omitempty"` + // AverageImpressionFrequencyPerUser: The average number of times a unique user + // saw your ad during the requested time period. This metric cannot be + // aggregated, and can only be requested for date ranges of 92 days or less. + // This metric is available for following campaign types - Display, Video, + // Discovery and App. + AverageImpressionFrequencyPerUser float64 `json:"averageImpressionFrequencyPerUser,omitempty"` + // AverageOrderValueMicros: Average order value is the average revenue you made + // per order attributed to your ads. How it works: You report conversions with + // cart data for completed purchases on your website. Average order value is + // the total revenue from your orders divided by the total number of orders. + // Example: You received 3 orders which made $10, $15 and $20 worth of revenue. + // The average order value is $15 = ($10 + $15 + $20)/3. This metric is only + // available if you report conversions with cart data. + AverageOrderValueMicros int64 `json:"averageOrderValueMicros,omitempty,string"` // AverageQualityScore: The average quality score. AverageQualityScore float64 `json:"averageQualityScore,omitempty"` // Clicks: The number of clicks. @@ -1257,6 +1316,17 @@ type GoogleAdsSearchads360V0Common__Metrics struct { // parameter at // https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause CostMicros int64 `json:"costMicros,omitempty,string"` + // CostOfGoodsSoldMicros: Cost of goods sold (COGS) is the total cost of the + // products you sold in orders attributed to your ads. How it works: You can + // add a cost of goods sold value to every product in Merchant Center. If you + // report conversions with cart data, the products you sold are matched with + // their cost of goods sold value and this can be used to calculate the gross + // profit you made on each order. Example: Someone clicked on a Shopping ad for + // a hat then bought the same hat and a shirt. The hat has a cost of goods sold + // value of $3, the shirt has a cost of goods sold value of $5. The cost of + // goods sold for this order is $8 = $3 + $5. This metric is only available if + // you report conversions with cart data. + CostOfGoodsSoldMicros int64 `json:"costOfGoodsSoldMicros,omitempty,string"` // CostPerAllConversions: The cost of ad interactions divided by all // conversions. CostPerAllConversions float64 `json:"costPerAllConversions,omitempty"` @@ -1365,6 +1435,32 @@ type GoogleAdsSearchads360V0Common__Metrics struct { // don't affect your account statistics. See the help page at // https://support.google.com/campaignmanager/answer/6076504 for details. GeneralInvalidClicks int64 `json:"generalInvalidClicks,omitempty,string"` + // GrossProfitMargin: Gross profit margin is the percentage gross profit you + // made from orders attributed to your ads, after taking out the cost of goods + // sold (COGS). How it works: You report conversions with cart data for + // completed purchases on your website. Gross profit margin is the gross profit + // you made divided by your total revenue and multiplied by 100%. Gross profit + // margin calculations only include products that have a cost of goods sold + // value in Merchant Center. Example: Someone bought a hat and a shirt in an + // order on your website. The hat is priced $10 and has a cost of goods sold + // value of $3. The shirt is priced $20 but has no cost of goods sold value. + // Gross profit margin for this order will only take into account the hat + // because it has a cost of goods sold value, so it's 70% = ($10 - $3)/$10 x + // 100%. This metric is only available if you report conversions with cart + // data. + GrossProfitMargin float64 `json:"grossProfitMargin,omitempty"` + // GrossProfitMicros: Gross profit is the profit you made from orders + // attributed to your ads minus the cost of goods sold (COGS). How it works: + // Gross profit is the revenue you made from sales attributed to your ads minus + // cost of goods sold. Gross profit calculations only include products that + // have a cost of goods sold value in Merchant Center. Example: Someone clicked + // on a Shopping ad for a hat then bought the same hat and a shirt in an order + // from your website. The hat is priced $10 and the shirt is priced $20. The + // hat has a cost of goods sold value of $3, but the shirt has no cost of goods + // sold value. Gross profit for this order will only take into account the hat, + // so it's $7 = $10 - $3. This metric is only available if you report + // conversions with cart data. + GrossProfitMicros int64 `json:"grossProfitMicros,omitempty,string"` // HistoricalCreativeQualityScore: The creative historical quality score. // // Possible values: @@ -1495,8 +1591,28 @@ type GoogleAdsSearchads360V0Common__Metrics struct { // MobileFriendlyClicksPercentage: The percentage of mobile clicks that go to a // mobile-friendly page. MobileFriendlyClicksPercentage float64 `json:"mobileFriendlyClicksPercentage,omitempty"` + // Orders: Orders is the total number of purchase conversions you received + // attributed to your ads. How it works: You report conversions with cart data + // for completed purchases on your website. If a conversion is attributed to + // previous interactions with your ads (clicks for text or Shopping ads, views + // for video ads etc.) it's counted as an order. Example: Someone clicked on a + // Shopping ad for a hat then bought the same hat and a shirt in an order on + // your website. Even though they bought 2 products, this would count as 1 + // order. This metric is only available if you report conversions with cart + // data. + Orders float64 `json:"orders,omitempty"` // RawEventConversionMetrics: The raw event conversion metrics. RawEventConversionMetrics []*GoogleAdsSearchads360V0Common__Value `json:"rawEventConversionMetrics,omitempty"` + // RevenueMicros: Revenue is the total amount you made from orders attributed + // to your ads. How it works: You report conversions with cart data for + // completed purchases on your website. Revenue is the total value of all the + // orders you received attributed to your ads, minus any discount. Example: + // Someone clicked on a Shopping ad for a hat then bought the same hat and a + // shirt in an order from your website. The hat is priced $10 and the shirt is + // priced $20. The entire order has a $5 discount. The revenue from this order + // is $25 = ($10 + $20) - $5. This metric is only available if you report + // conversions with cart data. + RevenueMicros int64 `json:"revenueMicros,omitempty,string"` // SearchAbsoluteTopImpressionShare: The percentage of the customer's Shopping // or Search ad impressions that are shown in the most prominent Shopping // position. See https://support.google.com/sa360/answer/9566729 for details. @@ -1561,6 +1677,19 @@ type GoogleAdsSearchads360V0Common__Metrics struct { // TopImpressionPercentage: The percent of your ad impressions that are shown // adjacent to the top organic search results. TopImpressionPercentage float64 `json:"topImpressionPercentage,omitempty"` + // UniqueUsers: The number of unique users who saw your ad during the requested + // time period. This metric cannot be aggregated, and can only be requested for + // date ranges of 92 days or less. This metric is available for following + // campaign types - Display, Video, Discovery and App. + UniqueUsers int64 `json:"uniqueUsers,omitempty,string"` + // UnitsSold: Units sold is the total number of products sold from orders + // attributed to your ads. How it works: You report conversions with cart data + // for completed purchases on your website. Units sold is the total number of + // products sold from all orders attributed to your ads. Example: Someone + // clicked on a Shopping ad for a hat then bought the same hat, a shirt and a + // jacket. The units sold in this order is 3. This metric is only available if + // you report conversions with cart data. + UnitsSold float64 `json:"unitsSold,omitempty"` // ValuePerAllConversions: The value of all conversions divided by the number // of all conversions. ValuePerAllConversions float64 `json:"valuePerAllConversions,omitempty"` @@ -1620,9 +1749,11 @@ func (s *GoogleAdsSearchads360V0Common__Metrics) UnmarshalJSON(data []byte) erro AllConversionsValue gensupport.JSONFloat64 `json:"allConversionsValue"` AllConversionsValueByConversionDate gensupport.JSONFloat64 `json:"allConversionsValueByConversionDate"` AllConversionsValuePerCost gensupport.JSONFloat64 `json:"allConversionsValuePerCost"` + AverageCartSize gensupport.JSONFloat64 `json:"averageCartSize"` AverageCost gensupport.JSONFloat64 `json:"averageCost"` AverageCpc gensupport.JSONFloat64 `json:"averageCpc"` AverageCpm gensupport.JSONFloat64 `json:"averageCpm"` + AverageImpressionFrequencyPerUser gensupport.JSONFloat64 `json:"averageImpressionFrequencyPerUser"` AverageQualityScore gensupport.JSONFloat64 `json:"averageQualityScore"` ClientAccountConversions gensupport.JSONFloat64 `json:"clientAccountConversions"` ClientAccountConversionsValue gensupport.JSONFloat64 `json:"clientAccountConversionsValue"` @@ -1648,10 +1779,12 @@ func (s *GoogleAdsSearchads360V0Common__Metrics) UnmarshalJSON(data []byte) erro CrossSellUnitsSold gensupport.JSONFloat64 `json:"crossSellUnitsSold"` Ctr gensupport.JSONFloat64 `json:"ctr"` GeneralInvalidClickRate gensupport.JSONFloat64 `json:"generalInvalidClickRate"` + GrossProfitMargin gensupport.JSONFloat64 `json:"grossProfitMargin"` InteractionRate gensupport.JSONFloat64 `json:"interactionRate"` InvalidClickRate gensupport.JSONFloat64 `json:"invalidClickRate"` LeadUnitsSold gensupport.JSONFloat64 `json:"leadUnitsSold"` MobileFriendlyClicksPercentage gensupport.JSONFloat64 `json:"mobileFriendlyClicksPercentage"` + Orders gensupport.JSONFloat64 `json:"orders"` SearchAbsoluteTopImpressionShare gensupport.JSONFloat64 `json:"searchAbsoluteTopImpressionShare"` SearchBudgetLostAbsoluteTopImpressionShare gensupport.JSONFloat64 `json:"searchBudgetLostAbsoluteTopImpressionShare"` SearchBudgetLostImpressionShare gensupport.JSONFloat64 `json:"searchBudgetLostImpressionShare"` @@ -1664,6 +1797,7 @@ func (s *GoogleAdsSearchads360V0Common__Metrics) UnmarshalJSON(data []byte) erro SearchRankLostTopImpressionShare gensupport.JSONFloat64 `json:"searchRankLostTopImpressionShare"` SearchTopImpressionShare gensupport.JSONFloat64 `json:"searchTopImpressionShare"` TopImpressionPercentage gensupport.JSONFloat64 `json:"topImpressionPercentage"` + UnitsSold gensupport.JSONFloat64 `json:"unitsSold"` ValuePerAllConversions gensupport.JSONFloat64 `json:"valuePerAllConversions"` ValuePerAllConversionsByConversionDate gensupport.JSONFloat64 `json:"valuePerAllConversionsByConversionDate"` ValuePerConversion gensupport.JSONFloat64 `json:"valuePerConversion"` @@ -1690,9 +1824,11 @@ func (s *GoogleAdsSearchads360V0Common__Metrics) UnmarshalJSON(data []byte) erro s.AllConversionsValue = float64(s1.AllConversionsValue) s.AllConversionsValueByConversionDate = float64(s1.AllConversionsValueByConversionDate) s.AllConversionsValuePerCost = float64(s1.AllConversionsValuePerCost) + s.AverageCartSize = float64(s1.AverageCartSize) s.AverageCost = float64(s1.AverageCost) s.AverageCpc = float64(s1.AverageCpc) s.AverageCpm = float64(s1.AverageCpm) + s.AverageImpressionFrequencyPerUser = float64(s1.AverageImpressionFrequencyPerUser) s.AverageQualityScore = float64(s1.AverageQualityScore) s.ClientAccountConversions = float64(s1.ClientAccountConversions) s.ClientAccountConversionsValue = float64(s1.ClientAccountConversionsValue) @@ -1718,10 +1854,12 @@ func (s *GoogleAdsSearchads360V0Common__Metrics) UnmarshalJSON(data []byte) erro s.CrossSellUnitsSold = float64(s1.CrossSellUnitsSold) s.Ctr = float64(s1.Ctr) s.GeneralInvalidClickRate = float64(s1.GeneralInvalidClickRate) + s.GrossProfitMargin = float64(s1.GrossProfitMargin) s.InteractionRate = float64(s1.InteractionRate) s.InvalidClickRate = float64(s1.InvalidClickRate) s.LeadUnitsSold = float64(s1.LeadUnitsSold) s.MobileFriendlyClicksPercentage = float64(s1.MobileFriendlyClicksPercentage) + s.Orders = float64(s1.Orders) s.SearchAbsoluteTopImpressionShare = float64(s1.SearchAbsoluteTopImpressionShare) s.SearchBudgetLostAbsoluteTopImpressionShare = float64(s1.SearchBudgetLostAbsoluteTopImpressionShare) s.SearchBudgetLostImpressionShare = float64(s1.SearchBudgetLostImpressionShare) @@ -1734,6 +1872,7 @@ func (s *GoogleAdsSearchads360V0Common__Metrics) UnmarshalJSON(data []byte) erro s.SearchRankLostTopImpressionShare = float64(s1.SearchRankLostTopImpressionShare) s.SearchTopImpressionShare = float64(s1.SearchTopImpressionShare) s.TopImpressionPercentage = float64(s1.TopImpressionPercentage) + s.UnitsSold = float64(s1.UnitsSold) s.ValuePerAllConversions = float64(s1.ValuePerAllConversions) s.ValuePerAllConversionsByConversionDate = float64(s1.ValuePerAllConversionsByConversionDate) s.ValuePerConversion = float64(s1.ValuePerConversion) @@ -4524,6 +4663,14 @@ type GoogleAdsSearchads360V0Resources__Ad struct { ExpandedDynamicSearchAd *GoogleAdsSearchads360V0Common__SearchAds360ExpandedDynamicSearchAdInfo `json:"expandedDynamicSearchAd,omitempty"` // ExpandedTextAd: Immutable. Details pertaining to an expanded text ad. ExpandedTextAd *GoogleAdsSearchads360V0Common__SearchAds360ExpandedTextAdInfo `json:"expandedTextAd,omitempty"` + // FinalAppUrls: A list of final app URLs that will be used on mobile if the + // user has the specific app installed. + FinalAppUrls []*GoogleAdsSearchads360V0Common__FinalAppUrl `json:"finalAppUrls,omitempty"` + // FinalMobileUrls: The list of possible final mobile URLs after all + // cross-domain redirects for the ad. + FinalMobileUrls []string `json:"finalMobileUrls,omitempty"` + // FinalUrlSuffix: The suffix to use when constructing a final URL. + FinalUrlSuffix string `json:"finalUrlSuffix,omitempty"` // FinalUrls: The list of possible final URLs after all cross-domain redirects // for the ad. FinalUrls []string `json:"finalUrls,omitempty"` @@ -4542,6 +4689,8 @@ type GoogleAdsSearchads360V0Resources__Ad struct { ResponsiveSearchAd *GoogleAdsSearchads360V0Common__SearchAds360ResponsiveSearchAdInfo `json:"responsiveSearchAd,omitempty"` // TextAd: Immutable. Details pertaining to a text ad. TextAd *GoogleAdsSearchads360V0Common__SearchAds360TextAdInfo `json:"textAd,omitempty"` + // TrackingUrlTemplate: The URL template for constructing a tracking URL. + TrackingUrlTemplate string `json:"trackingUrlTemplate,omitempty"` // Type: Output only. The type of ad. // // Possible values: @@ -4655,6 +4804,8 @@ type GoogleAdsSearchads360V0Resources__AdGroup struct { // "ACCOUNT_PAUSED" - No ads are running for this ad group, because the // account has been paused. EngineStatus string `json:"engineStatus,omitempty"` + // FinalUrlSuffix: URL template for appending params to Final URL. + FinalUrlSuffix string `json:"finalUrlSuffix,omitempty"` // Id: Output only. The ID of the ad group. Id int64 `json:"id,omitempty,string"` // Labels: Output only. The resource names of labels attached to this ad group. @@ -4696,6 +4847,8 @@ type GoogleAdsSearchads360V0Resources__AdGroup struct { Status string `json:"status,omitempty"` // TargetingSetting: Setting for targeting related features. TargetingSetting *GoogleAdsSearchads360V0Common__TargetingSetting `json:"targetingSetting,omitempty"` + // TrackingUrlTemplate: The URL template for constructing a tracking URL. + TrackingUrlTemplate string `json:"trackingUrlTemplate,omitempty"` // Type: Immutable. The type of the ad group. // // Possible values: @@ -4844,8 +4997,8 @@ type GoogleAdsSearchads360V0Resources__AdGroupAdEffectiveLabel struct { OwnerCustomerId int64 `json:"ownerCustomerId,omitempty,string"` // ResourceName: Immutable. The resource name of the ad group ad effective // label. Ad group ad effective label resource names have the form: - // `customers/{customer_id}/adGroupAdEffectiveLabels/{ad_group_id}~{ad_id}~{labe - // l_id}` + // `customers/{owner_customer_id}/adGroupAdEffectiveLabels/{ad_group_id}~{ad_id} + // ~{label_id}` ResourceName string `json:"resourceName,omitempty"` // ForceSendFields is a list of field names (e.g. "AdGroupAd") to // unconditionally include in API requests. By default, fields with empty or @@ -4876,7 +5029,8 @@ type GoogleAdsSearchads360V0Resources__AdGroupAdLabel struct { OwnerCustomerId int64 `json:"ownerCustomerId,omitempty,string"` // ResourceName: Immutable. The resource name of the ad group ad label. Ad // group ad label resource names have the form: - // `customers/{customer_id}/adGroupAdLabels/{ad_group_id}~{ad_id}~{label_id}` + // `customers/{owner_customer_id}/adGroupAdLabels/{ad_group_id}~{ad_id}~{label_i + // d}` ResourceName string `json:"resourceName,omitempty"` // ForceSendFields is a list of field names (e.g. "AdGroupAd") to // unconditionally include in API requests. By default, fields with empty or @@ -5114,6 +5268,9 @@ type GoogleAdsSearchads360V0Resources__AdGroupCriterion struct { // "AD_GROUP_CRITERION_ACCOUNT_PAUSED" - Criterion has been paused since the // account is paused. EngineStatus string `json:"engineStatus,omitempty"` + // FinalMobileUrls: The list of possible final mobile URLs after all + // cross-domain redirects. + FinalMobileUrls []string `json:"finalMobileUrls,omitempty"` // FinalUrlSuffix: URL template for appending params to final URL. FinalUrlSuffix string `json:"finalUrlSuffix,omitempty"` // FinalUrls: The list of possible final URLs after all cross-domain redirects @@ -5214,6 +5371,10 @@ type GoogleAdsSearchads360V0Resources__AdGroupCriterion struct { // "BRAND_LIST" - Brand List // "LIFE_EVENT" - Life Event Type string `json:"type,omitempty"` + // UrlCustomParameters: The list of mappings used to substitute custom + // parameter tags in a `tracking_url_template`, `final_urls`, or + // `mobile_final_urls`. + UrlCustomParameters []*GoogleAdsSearchads360V0Common__CustomParameter `json:"urlCustomParameters,omitempty"` // UserList: Immutable. User List. UserList *GoogleAdsSearchads360V0Common__UserListInfo `json:"userList,omitempty"` // Webpage: Immutable. Webpage @@ -5266,8 +5427,8 @@ type GoogleAdsSearchads360V0Resources__AdGroupCriterionEffectiveLabel struct { // ResourceName: Immutable. The resource name of the ad group criterion // effective label. Ad group criterion effective label resource names have the // form: - // `customers/{customer_id}/adGroupCriterionEffectiveLabels/{ad_group_id}~{crite - // rion_id}~{label_id}` + // `customers/{owner_customer_id}/adGroupCriterionEffectiveLabels/{ad_group_id}~ + // {criterion_id}~{label_id}` ResourceName string `json:"resourceName,omitempty"` // ForceSendFields is a list of field names (e.g. "AdGroupCriterion") to // unconditionally include in API requests. By default, fields with empty or @@ -5299,8 +5460,8 @@ type GoogleAdsSearchads360V0Resources__AdGroupCriterionLabel struct { OwnerCustomerId int64 `json:"ownerCustomerId,omitempty,string"` // ResourceName: Immutable. The resource name of the ad group criterion label. // Ad group criterion label resource names have the form: - // `customers/{customer_id}/adGroupCriterionLabels/{ad_group_id}~{criterion_id}~ - // {label_id}` + // `customers/{owner_customer_id}/adGroupCriterionLabels/{ad_group_id}~{criterio + // n_id}~{label_id}` ResourceName string `json:"resourceName,omitempty"` // ForceSendFields is a list of field names (e.g. "AdGroupCriterion") to // unconditionally include in API requests. By default, fields with empty or @@ -5333,7 +5494,8 @@ type GoogleAdsSearchads360V0Resources__AdGroupEffectiveLabel struct { OwnerCustomerId int64 `json:"ownerCustomerId,omitempty,string"` // ResourceName: Immutable. The resource name of the ad group effective label. // Ad group effective label resource names have the form: - // `customers/{customer_id}/adGroupEffectiveLabels/{ad_group_id}~{label_id}` + // `customers/{owner_customer_id}/adGroupEffectiveLabels/{ad_group_id}~{label_id + // }` ResourceName string `json:"resourceName,omitempty"` // ForceSendFields is a list of field names (e.g. "AdGroup") to unconditionally // include in API requests. By default, fields with empty or default values are @@ -5364,7 +5526,7 @@ type GoogleAdsSearchads360V0Resources__AdGroupLabel struct { OwnerCustomerId int64 `json:"ownerCustomerId,omitempty,string"` // ResourceName: Immutable. The resource name of the ad group label. Ad group // label resource names have the form: - // `customers/{customer_id}/adGroupLabels/{ad_group_id}~{label_id}` + // `customers/{owner_customer_id}/adGroupLabels/{ad_group_id}~{label_id}` ResourceName string `json:"resourceName,omitempty"` // ForceSendFields is a list of field names (e.g. "AdGroup") to unconditionally // include in API requests. By default, fields with empty or default values are @@ -5436,6 +5598,12 @@ type GoogleAdsSearchads360V0Resources__Asset struct { // "DISABLED" - The asset is inactive (pending). // "REMOVED" - The asset has been removed. EngineStatus string `json:"engineStatus,omitempty"` + // FinalMobileUrls: A list of possible final mobile URLs after all cross domain + // redirects. + FinalMobileUrls []string `json:"finalMobileUrls,omitempty"` + // FinalUrlSuffix: URL template for appending params to landing page URLs + // served with parallel tracking. + FinalUrlSuffix string `json:"finalUrlSuffix,omitempty"` // FinalUrls: A list of possible final URLs after all cross domain redirects. FinalUrls []string `json:"finalUrls,omitempty"` // Id: Output only. The ID of the asset. @@ -5509,6 +5677,10 @@ type GoogleAdsSearchads360V0Resources__Asset struct { // "LOCATION" - Location asset. // "HOTEL_PROPERTY" - Hotel property asset. Type string `json:"type,omitempty"` + // UrlCustomParameters: A list of mappings to be used for substituting URL + // custom parameter tags in the tracking_url_template, final_urls, and/or + // final_mobile_urls. + UrlCustomParameters []*GoogleAdsSearchads360V0Common__CustomParameter `json:"urlCustomParameters,omitempty"` // YoutubeVideoAsset: Immutable. A YouTube video asset. YoutubeVideoAsset *GoogleAdsSearchads360V0Common__YoutubeVideoAsset `json:"youtubeVideoAsset,omitempty"` // ForceSendFields is a list of field names (e.g. "CallAsset") to @@ -5651,6 +5823,8 @@ type GoogleAdsSearchads360V0Resources__AssetGroupAsset struct { // Performance Max for travel goals campaign. // "DISCOVERY_CAROUSEL_CARD" - The asset is linked for use as a discovery // carousel card. + // "LONG_DESCRIPTION" - The asset is linked for use as a long description. + // "CALL_TO_ACTION" - The asset is linked for use as a call-to-action. FieldType string `json:"fieldType,omitempty"` // ResourceName: Immutable. The resource name of the asset group asset. Asset // group asset resource name have the form: @@ -6362,7 +6536,38 @@ type GoogleAdsSearchads360V0Resources__Campaign struct { // Performance Max for travel goals campaign. // "DISCOVERY_CAROUSEL_CARD" - The asset is linked for use as a discovery // carousel card. + // "LONG_DESCRIPTION" - The asset is linked for use as a long description. + // "CALL_TO_ACTION" - The asset is linked for use as a call-to-action. ExcludedParentAssetFieldTypes []string `json:"excludedParentAssetFieldTypes,omitempty"` + // FeedTypes: Output only. Types of feeds that are attached directly to this + // campaign. + // + // Possible values: + // "UNSPECIFIED" - Not specified. + // "UNKNOWN" - Used for return value only. Represents value unknown in this + // version. + // "PAGE_FEED" - Page asset set. + // "DYNAMIC_EDUCATION" - Dynamic education asset set. + // "MERCHANT_CENTER_FEED" - Google Merchant Center asset set. + // "DYNAMIC_REAL_ESTATE" - Dynamic real estate asset set. + // "DYNAMIC_CUSTOM" - Dynamic custom asset set. + // "DYNAMIC_HOTELS_AND_RENTALS" - Dynamic hotels and rentals asset set. + // "DYNAMIC_FLIGHTS" - Dynamic flights asset set. + // "DYNAMIC_TRAVEL" - Dynamic travel asset set. + // "DYNAMIC_LOCAL" - Dynamic local asset set. + // "DYNAMIC_JOBS" - Dynamic jobs asset set. + // "LOCATION_SYNC" - Location sync level asset set. + // "BUSINESS_PROFILE_DYNAMIC_LOCATION_GROUP" - Business Profile location + // group asset set. + // "CHAIN_DYNAMIC_LOCATION_GROUP" - Chain location group asset set which can + // be used for both owned locations and affiliate locations. + // "STATIC_LOCATION_GROUP" - Static location group asset set which can be + // used for both owned locations and affiliate locations. + // "HOTEL_PROPERTY" - Hotel Property asset set which is used to link a hotel + // property feed to Performance Max for travel goals campaigns. + // "TRAVEL_FEED" - Travel Feed asset set type. Can represent either a Hotel + // feed or a Things to Do (activities) feed. + FeedTypes []string `json:"feedTypes,omitempty"` // FinalUrlSuffix: Suffix used to append query parameters to landing pages that // are served with parallel tracking. FinalUrlSuffix string `json:"finalUrlSuffix,omitempty"` @@ -6804,7 +7009,8 @@ type GoogleAdsSearchads360V0Resources__CampaignEffectiveLabel struct { OwnerCustomerId int64 `json:"ownerCustomerId,omitempty,string"` // ResourceName: Immutable. Name of the resource. CampaignEffectivelabel // resource names have the form: - // `customers/{customer_id}/campaignEffectiveLabels/{campaign_id}~{label_id}` + // `customers/{owner_customer_id}/campaignEffectiveLabels/{campaign_id}~{label_i + // d}` ResourceName string `json:"resourceName,omitempty"` // ForceSendFields is a list of field names (e.g. "Campaign") to // unconditionally include in API requests. By default, fields with empty or @@ -6835,7 +7041,7 @@ type GoogleAdsSearchads360V0Resources__CampaignLabel struct { OwnerCustomerId int64 `json:"ownerCustomerId,omitempty,string"` // ResourceName: Immutable. Name of the resource. Campaign label resource names // have the form: - // `customers/{customer_id}/campaignLabels/{campaign_id}~{label_id}` + // `customers/{owner_customer_id}/campaignLabels/{campaign_id}~{label_id}` ResourceName string `json:"resourceName,omitempty"` // ForceSendFields is a list of field names (e.g. "Campaign") to // unconditionally include in API requests. By default, fields with empty or @@ -6932,6 +7138,8 @@ type GoogleAdsSearchads360V0Resources__Conversion struct { // Performance Max for travel goals campaign. // "DISCOVERY_CAROUSEL_CARD" - The asset is linked for use as a discovery // carousel card. + // "LONG_DESCRIPTION" - The asset is linked for use as a long description. + // "CALL_TO_ACTION" - The asset is linked for use as a call-to-action. AssetFieldType string `json:"assetFieldType,omitempty"` // AssetId: Output only. ID of the asset which was interacted with during the // conversion event. @@ -7996,7 +8204,7 @@ type GoogleAdsSearchads360V0Resources__Label struct { // 80, inclusive. Name string `json:"name,omitempty"` // ResourceName: Immutable. Name of the resource. Label resource names have the - // form: `customers/{customer_id}/labels/{label_id}` + // form: `customers/{owner_customer_id}/labels/{label_id}` ResourceName string `json:"resourceName,omitempty"` // Status: Output only. Status of the label. Read only. // @@ -8344,7 +8552,16 @@ func (s GoogleAdsSearchads360V0Resources__SearchAds360Field) MarshalJSON() ([]by // several product dimension levels. Product dimension values from Merchant // Center such as brand, category, custom attributes, product condition and // product type will reflect the state of each dimension as of the date and -// time when the corresponding event was recorded. +// time when the corresponding event was recorded. The number of impressions +// and clicks that shopping_performance_view returns stats for may be different +// from campaign reports. shopping_performance_view shows impressions and +// clicks on products appearing in ads, while campaign reports show impressions +// and clicks on the ads themselves. Depending on the format, an ad can show +// from zero to several products, so the numbers may not match. In Google Ads +// UI, you can query impressions and clicks of products appearing in ads by +// selecting a column from "Product attributes" in the report editor. For +// example, selecting the "Brand" column is equivalent to selecting +// `segments.product_brand`. type GoogleAdsSearchads360V0Resources__ShoppingPerformanceView struct { // ResourceName: Output only. The resource name of the Shopping performance // view. Shopping performance view resource names have the form: @@ -8495,6 +8712,8 @@ type GoogleAdsSearchads360V0Resources__Visit struct { // Performance Max for travel goals campaign. // "DISCOVERY_CAROUSEL_CARD" - The asset is linked for use as a discovery // carousel card. + // "LONG_DESCRIPTION" - The asset is linked for use as a long description. + // "CALL_TO_ACTION" - The asset is linked for use as a call-to-action. AssetFieldType string `json:"assetFieldType,omitempty"` // AssetId: Output only. ID of the asset which was interacted with during the // visit event. diff --git a/secretmanager/v1beta1/secretmanager-api.json b/secretmanager/v1beta1/secretmanager-api.json index 7a508b2aabc..dba947b7a21 100644 --- a/secretmanager/v1beta1/secretmanager-api.json +++ b/secretmanager/v1beta1/secretmanager-api.json @@ -26,11 +26,31 @@ "endpointUrl": "https://secretmanager.africa-south1.rep.googleapis.com/", "location": "africa-south1" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.asia-east1.rep.googleapis.com/", + "location": "asia-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.asia-east2.rep.googleapis.com/", + "location": "asia-east2" + }, { "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.asia-northeast1.rep.googleapis.com/", "location": "asia-northeast1" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.asia-northeast2.rep.googleapis.com/", + "location": "asia-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.asia-northeast3.rep.googleapis.com/", + "location": "asia-northeast3" + }, { "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.asia-south1.rep.googleapis.com/", @@ -51,6 +71,11 @@ "endpointUrl": "https://secretmanager.asia-southeast2.rep.googleapis.com/", "location": "asia-southeast2" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.asia-southeast3.rep.googleapis.com/", + "location": "asia-southeast3" + }, { "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.australia-southeast1.rep.googleapis.com/", @@ -66,16 +91,31 @@ "endpointUrl": "https://secretmanager.europe-central2.rep.googleapis.com/", "location": "europe-central2" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.europe-north1.rep.googleapis.com/", + "location": "europe-north1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.europe-north2.rep.googleapis.com/", "location": "europe-north2" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.europe-southwest1.rep.googleapis.com/", + "location": "europe-southwest1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.europe-west1.rep.googleapis.com/", "location": "europe-west1" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.europe-west10.rep.googleapis.com/", + "location": "europe-west10" + }, { "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.europe-west12.rep.googleapis.com/", @@ -136,6 +176,11 @@ "endpointUrl": "https://secretmanager.northamerica-northeast2.rep.googleapis.com/", "location": "northamerica-northeast2" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.southamerica-east1.rep.googleapis.com/", @@ -341,7 +386,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -831,7 +876,7 @@ } } }, - "revision": "20251004", + "revision": "20251105", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/secretmanager/v1beta1/secretmanager-gen.go b/secretmanager/v1beta1/secretmanager-gen.go index a4e7446c8ee..afa6c2681c6 100644 --- a/secretmanager/v1beta1/secretmanager-gen.go +++ b/secretmanager/v1beta1/secretmanager-gen.go @@ -1116,9 +1116,9 @@ func (r *ProjectsLocationsService) List(name string) *ProjectsLocationsListCall return c } -// ExtraLocationTypes sets the optional parameter "extraLocationTypes": Unless -// explicitly documented otherwise, don't use this unsupported field which is -// primarily intended for internal usage. +// ExtraLocationTypes sets the optional parameter "extraLocationTypes": Do not +// use this field. It is unsupported and is ignored unless explicitly +// documented otherwise. This is primarily for internal usage. func (c *ProjectsLocationsListCall) ExtraLocationTypes(extraLocationTypes ...string) *ProjectsLocationsListCall { c.urlParams_.SetMulti("extraLocationTypes", append([]string{}, extraLocationTypes...)) return c