@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20240530 → 0.0.20240607

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1alpha
-// Revision: 20240530
+// Revision: 20240607
 
 /// <reference types="gapi.client" />
 
@@ -28,6 +28,64 @@ declare namespace gapi.client {
   ): void;
 
   namespace discoveryengine {
+    interface GoogleApiDistribution {
+      /** The number of values in each bucket of the histogram, as described in `bucket_options`. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values in `bucket_counts` must equal the value in the `count` field of the distribution. If present, `bucket_counts` should contain N values, where N is the number of buckets specified in `bucket_options`. If you supply fewer than N values, the remaining values are assumed to be 0. The order of the values in `bucket_counts` follows the bucket numbering schemes described for the three bucket types. The first value must be the count for the underflow bucket (number 0). The next N-2 values are the counts for the finite buckets (number 1 through N-2). The N'th value in `bucket_counts` is the count for the overflow bucket (number N-1). */
+      bucketCounts?: string[];
+      /** Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field. */
+      bucketOptions?: GoogleApiDistributionBucketOptions;
+      /** The number of values in the population. Must be non-negative. This value must equal the sum of the values in `bucket_counts` if a histogram is provided. */
+      count?: string;
+      /** Must be in increasing order of `value` field. */
+      exemplars?: GoogleApiDistributionExemplar[];
+      /** The arithmetic mean of the values in the population. If `count` is zero then this field must be zero. */
+      mean?: number;
+      /** If specified, contains the range of the population values. The field must not be present if the `count` is zero. */
+      range?: GoogleApiDistributionRange;
+      /** The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, "The Art of Computer Programming", Vol. 2, page 232, 3rd edition describes Welford's method for accumulating this sum in one pass. If `count` is zero then this field must be zero. */
+      sumOfSquaredDeviation?: number;
+    }
+    interface GoogleApiDistributionBucketOptions {
+      /** The explicit buckets. */
+      explicitBuckets?: GoogleApiDistributionBucketOptionsExplicit;
+      /** The exponential buckets. */
+      exponentialBuckets?: GoogleApiDistributionBucketOptionsExponential;
+      /** The linear bucket. */
+      linearBuckets?: GoogleApiDistributionBucketOptionsLinear;
+    }
+    interface GoogleApiDistributionBucketOptionsExplicit {
+      /** The values must be monotonically increasing. */
+      bounds?: number[];
+    }
+    interface GoogleApiDistributionBucketOptionsExponential {
+      /** Must be greater than 1. */
+      growthFactor?: number;
+      /** Must be greater than 0. */
+      numFiniteBuckets?: number;
+      /** Must be greater than 0. */
+      scale?: number;
+    }
+    interface GoogleApiDistributionBucketOptionsLinear {
+      /** Must be greater than 0. */
+      numFiniteBuckets?: number;
+      /** Lower bound of the first bucket. */
+      offset?: number;
+      /** Must be greater than 0. */
+      width?: number;
+    }
+    interface GoogleApiDistributionExemplar {
+      /** Contextual information about the example value. Examples are: Trace: type.googleapis.com/google.monitoring.v3.SpanContext Literal string: type.googleapis.com/google.protobuf.StringValue Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system. */
+      attachments?: Array<{[P in string]: any}>;
+      /** The observation (sampling) time of the above value. */
+      timestamp?: string;
+      /** Value of the exemplar point. This value determines to which bucket the exemplar belongs. */
+      value?: number;
+    }
+    interface GoogleApiDistributionRange {
+      /** The maximum of the population values. */
+      max?: number;
+      /** The minimum of the population values. */
+      min?: number;
+    }
     interface GoogleApiHttpBody {
       /** The HTTP Content-Type header value specifying the content type of the body. */
       contentType?: string;
@@ -36,6 +94,12 @@ declare namespace gapi.client {
       /** Application specific response metadata. Must be set in the first response for streaming APIs. */
       extensions?: Array<{[P in string]: any}>;
     }
+    interface GoogleApiMonitoredResource {
+      /** Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels `"project_id"`, `"instance_id"`, and `"zone"`. */
+      labels?: {[P in string]: string};
+      /** Required. The monitored resource type. This field must match the `type` field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is `gce_instance`. Some descriptors include the service name in the type; for example, the type of a Datastream stream is `datastream.googleapis.com/Stream`. */
+      type?: string;
+    }
     interface GoogleCloudDiscoveryengineLoggingErrorContext {
       /** The HTTP request which was processed when the error was triggered. */
       httpRequest?: GoogleCloudDiscoveryengineLoggingHttpRequestContext;
@@ -493,6 +557,36 @@ declare namespace gapi.client {
       /** The threshold (in [0,1]) used for determining whether a fact must be cited for a claim in the answer candidate. Choosing a higher threshold will lead to fewer but very strong citations, while choosing a lower threshold may lead to more but somewhat weaker citations. If unset, the threshold will default to 0.6. */
       citationThreshold?: number;
     }
+    interface GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest {
+      /** A Requirement.type specifying the requirement to check. */
+      requirementType?: string;
+      /** The resources to be checked for this requirement. */
+      resources?: GoogleApiMonitoredResource[];
+    }
+    interface GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse {
+      /** Metric results. */
+      metricResults?: GoogleCloudDiscoveryengineV1alphaCheckRequirementResponseMetricQueryResult[];
+      /** Timestamp of the oldest calculated metric (i.e. the most stale metric). Indicates that the `requirement_result` may not accurately reflect any Event and Product Catalog updates performed after this time. */
+      oldestMetricTimestamp?: string;
+      /** Requirement definition. */
+      requirement?: GoogleCloudDiscoveryengineV1alphaRequirement;
+      /** The condition for evaluating the requirement result. */
+      requirementCondition?: GoogleTypeExpr;
+      /** Requirement result, e.g. pass or fail. */
+      requirementResult?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaCheckRequirementResponseMetricQueryResult {
+      /** Type identifier of the metric corresponding to this query result. */
+      metricType?: string;
+      /** This metric query name is mapping to variables in the requirement_condition. */
+      name?: string;
+      /** Time corresponding to when this metric value was calculated. */
+      timestamp?: string;
+      /** The unit in which this metric is reported. Follows [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard. */
+      unit?: string;
+      /** Value of the metric query. */
+      value?: GoogleMonitoringV3TypedValue;
+    }
     interface GoogleCloudDiscoveryengineV1alphaChunk {
       /** Output only. Metadata of the current chunk. */
       chunkMetadata?: GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata;
@@ -1559,6 +1653,52 @@ declare namespace gapi.client {
       /** Required. The version string of the terms of service to update. */
       serviceTermVersion?: string;
     }
+    interface GoogleCloudDiscoveryengineV1alphaRequirement {
+      /** The condition for evaluating the requirement result. Variables in the expression should be provided by `metrics_bindings` or `threshold_bindings`. Where `metrics_bindings` are used for computed metrics and `threshold_bindings` are used to define thresholds for corresponding `metric_bindings`. */
+      condition?: GoogleTypeExpr;
+      /** The description of the requirement. */
+      description?: string;
+      /** The name of the requirement. */
+      displayName?: string;
+      /** A list of the metric bindings to be used in `condition`. */
+      metricBindings?: GoogleCloudDiscoveryengineV1alphaRequirementMetricBinding[];
+      /** A list of threshold bindings to be used in `condition`. */
+      thresholdBindings?: GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding[];
+      /** The requirement type, used as an identifier. Must be unique. The type should prefix with service name to avoid possible collision. It's encoraged to use natural hierarchical grouping for similar requirements. Examples: * `library.googleapis.com/books/min_available_books` * `discoveryengine.googleapis.com/media_rec/recommended_for_you/conversion_rate` */
+      type?: string;
+      /** A list of the metric bindings to be used in `condition`. */
+      violationSamplesBindings?: GoogleCloudDiscoveryengineV1alphaRequirementViolationSamplesBinding[];
+    }
+    interface GoogleCloudDiscoveryengineV1alphaRequirementMetricBinding {
+      /** The category of the metric's target resource. Example: "Events" */
+      category?: string;
+      /** Human readable description of the corresponding metric filter. */
+      description?: string;
+      /** The filter string used for metrics query. Example: "metric.type = \"discoveryengine.googleapis.com/events/day_count\" AND " "metric.conditions.time_range = \"NINETY_DAYS\"" */
+      metricFilter?: string;
+      /** The resource being monitored for the metric. */
+      resourceType?: string;
+      /** The variable id to be referenced in `condition`. */
+      variableId?: string;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding {
+      /** Threshold to trigger a blocking failure. If not met, the requirement will evaluate as a `FAILURE`. */
+      blockingThreshold?: number;
+      /** Human readable description of the corresponding threshold and sub-requirement. */
+      description?: string;
+      /** The variable id to be referenced in `condition`. Must be unique across all `metric_bindings` and `threshold_bindings`. */
+      variableId?: string;
+      /** Threshold to trigger a warning. If not met, the requirement will evaluate as a `WARNING`. */
+      warningThreshold?: number;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaRequirementViolationSamplesBinding {
+      /** Description of this sample binding. Used by the UI to render user friendly descriptions for each requirement condition. Should be less than 128 characters long. */
+      description?: string;
+      /** The filter string used for samples query. Example: "sample.type = \"retail.googleapis.com/user_event\" AND " "sample.labels.event_type = \"PURCHASE\" " */
+      sampleFilter?: string;
+      /** The variable id to be referenced in `condition`. */
+      variableId?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaResumeEngineRequest {}
     interface GoogleCloudDiscoveryengineV1alphaSchema {
       /** Output only. Configurations for fields of the schema. */
@@ -3053,6 +3193,18 @@ declare namespace gapi.client {
       /** The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */
       response?: {[P in string]: any};
     }
+    interface GoogleMonitoringV3TypedValue {
+      /** A Boolean value: `true` or `false`. */
+      boolValue?: boolean;
+      /** A distribution value. */
+      distributionValue?: GoogleApiDistribution;
+      /** A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision. */
+      doubleValue?: number;
+      /** A 64-bit integer. Its range is approximately ±9.2x1018. */
+      int64Value?: string;
+      /** A variable-length string value. */
+      stringValue?: string;
+    }
     interface GoogleProtobufEmpty {}
     interface GoogleRpcStatus {
       /** The status code, which should be an enum value of google.rpc.Code. */
@@ -3070,6 +3222,16 @@ declare namespace gapi.client {
       /** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
       year?: number;
     }
+    interface GoogleTypeExpr {
+      /** Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */
+      description?: string;
+      /** Textual representation of an expression in Common Expression Language syntax. */
+      expression?: string;
+      /** Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */
+      location?: string;
+      /** Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */
+      title?: string;
+    }
     interface OperationsResource {
       /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
       get(request?: {
@@ -11360,6 +11522,66 @@ declare namespace gapi.client {
         body: GoogleCloudDiscoveryengineV1alphaRankRequest
       ): Request<GoogleCloudDiscoveryengineV1alphaRankResponse>;
     }
+    interface RequirementsResource {
+      /** Check a particular requirement. */
+      checkRequirement(request: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** Required. Full resource name of the location. Format `projects/{project_number_or_id}/locations/{location}` */
+        location: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+        /** Request body */
+        resource: GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest;
+      }): Request<GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse>;
+      checkRequirement(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: string;
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: string;
+          /** JSONP */
+          callback?: string;
+          /** Selector specifying which fields to include in a partial response. */
+          fields?: string;
+          /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+          key?: string;
+          /** Required. Full resource name of the location. Format `projects/{project_number_or_id}/locations/{location}` */
+          location: string;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** Returns response with indentations and line breaks. */
+          prettyPrint?: boolean;
+          /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+          quotaUser?: string;
+          /** Upload protocol for media (e.g. "raw", "multipart"). */
+          upload_protocol?: string;
+          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+          uploadType?: string;
+        },
+        body: GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest
+      ): Request<GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse>;
+    }
     interface OperationsResource {
       /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
       get(request?: {
@@ -11393,6 +11615,39 @@ declare namespace gapi.client {
       operations: OperationsResource;
     }
     interface UserEventsResource {
+      /** Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly. */
+      collect(request?: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. */
+        ets?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
+        parent: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+        /** The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests. */
+        uri?: string;
+        /** Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. */
+        userEvent?: string;
+      }): Request<GoogleApiHttpBody>;
       /** Writes a single user event. */
       write(request: {
         /** V1 error format. */
@@ -11606,6 +11861,7 @@ declare namespace gapi.client {
       groundingConfigs: GroundingConfigsResource;
       operations: OperationsResource;
       rankingConfigs: RankingConfigsResource;
+      requirements: RequirementsResource;
       sampleQuerySets: SampleQuerySetsResource;
       userEvents: UserEventsResource;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.discoveryengine-v1alpha",
-  "version": "0.0.20240530",
+  "version": "0.0.20240607",
   "description": "TypeScript typings for Discovery Engine API v1alpha",
   "repository": {
     "type": "git",