googleapis
Version:
Google APIs Client Library for Node.js
929 lines • 2.12 MB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace discoveryengine_v1alpha {
export interface Options extends GlobalOptions {
version: 'v1alpha';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* 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;
/**
* 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;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Discovery Engine API
*
* Discovery Engine API.
*
* @example
* ```js
* const {google} = require('googleapis');
* const discoveryengine = google.discoveryengine('v1alpha');
* ```
*/
export class Discoveryengine {
context: APIRequestContext;
media: Resource$Media;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Extra information added to operations that support Scotty media requests.
*/
export interface Schema$ApiservingMediaRequestInfo {
/**
* The number of current bytes uploaded or downloaded.
*/
currentBytes?: string | null;
/**
* 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 | null;
/**
* 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.
*/
diffObjectVersion?: string | null;
/**
* 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?: number | null;
/**
* The type of notification received from Scotty.
*/
notificationType?: string | null;
/**
* The Scotty request ID.
*/
requestId?: string | null;
/**
* 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 | null;
/**
* The total size of the file.
*/
totalBytes?: string | null;
/**
* Whether the total bytes field contains an estimated data.
*/
totalBytesIsEstimated?: boolean | null;
}
/**
* 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 \}
*/
export interface Schema$ApiservingMediaResponseInfo {
/**
* 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 | null;
/**
* 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 | null;
/**
* 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?: number | null;
/**
* 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 | null;
/**
* Specifies the Scotty dropzone to use for uploads.
*/
dynamicDropzone?: string | null;
/**
* 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?: Schema$GdataMedia;
/**
* 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?: number | null;
/**
* Request class to use for all Blobstore operations for this request.
*/
requestClass?: string | null;
/**
* Requester ID passed along to be recorded in the Scotty logs
*/
scottyAgentUserId?: string | null;
/**
* Customer-specific data to be recorded in the Scotty logs type is logs_proto_scotty.CustomerLog
*/
scottyCustomerLog?: string | null;
/**
* 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.
*/
trafficClassField?: string | null;
/**
* Tells Scotty to verify hashes on the agent's behalf by parsing out the X-Goog-Hash header.
*/
verifyHashFromHeader?: boolean | null;
}
/**
* Information to read/write to blobstore2.
*/
export interface Schema$GdataBlobstore2Info {
/**
* The blob generation id.
*/
blobGeneration?: string | null;
/**
* The blob id, e.g., /blobstore/prod/playground/scotty
*/
blobId?: string | null;
/**
* 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 | null;
/**
* The blob read token. Needed to read blobs that have not been replicated. Might not be available until the final call.
*/
readToken?: string | null;
/**
* 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 | null;
}
/**
* A sequence of media data references representing composite data. Introduced to support Bigstore composite objects. For details, visit http://go/bigstore-composites.
*/
export interface Schema$GdataCompositeMedia {
/**
* 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 | null;
/**
* Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
*/
blobstore2Info?: Schema$GdataBlobstore2Info;
/**
* 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 | null;
/**
* crc32.c hash for the payload.
*/
crc32cHash?: number | null;
/**
* Media data, set if reference_type is INLINE
*/
inline?: string | null;
/**
* Size of the data, in bytes
*/
length?: string | null;
/**
* MD5 hash for the payload.
*/
md5Hash?: string | null;
/**
* Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
*/
objectId?: Schema$GdataObjectId;
/**
* Path to the data, set if reference_type is PATH
*/
path?: string | null;
/**
* Describes what the field reference contains.
*/
referenceType?: string | null;
/**
* SHA-1 hash for the payload.
*/
sha1Hash?: string | null;
}
/**
* 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.
*/
export interface Schema$GdataContentTypeInfo {
/**
* Scotty's best guess of what the content type of the file is.
*/
bestGuess?: string | null;
/**
* The content type of the file derived by looking at specific bytes (i.e. "magic bytes") of the actual file.
*/
fromBytes?: string | null;
/**
* The content type of the file derived from the file extension of the original file name used by the client.
*/
fromFileName?: string | null;
/**
* The content type of the file as specified in the request headers, multipart headers, or RUPIO start request.
*/
fromHeader?: string | null;
/**
* 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 | null;
}
/**
* Backend response for a Diff get checksums response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
*/
export interface Schema$GdataDiffChecksumsResponse {
/**
* 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?: Schema$GdataCompositeMedia;
/**
* The chunk size of checksums. Must be a multiple of 256KB.
*/
chunkSizeBytes?: string | null;
/**
* If set, calculate the checksums based on the contents and return them to the caller.
*/
objectLocation?: Schema$GdataCompositeMedia;
/**
* The total size of the server object.
*/
objectSizeBytes?: string | null;
/**
* The object version of the object the checksums are being returned for.
*/
objectVersion?: string | null;
}
/**
* Backend response for a Diff download response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
*/
export interface Schema$GdataDiffDownloadResponse {
/**
* The original object location.
*/
objectLocation?: Schema$GdataCompositeMedia;
}
/**
* A Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
*/
export interface Schema$GdataDiffUploadRequest {
/**
* 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?: Schema$GdataCompositeMedia;
/**
* 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?: Schema$GdataCompositeMedia;
/**
* 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 | null;
}
/**
* Backend response for a Diff upload request. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
*/
export interface Schema$GdataDiffUploadResponse {
/**
* 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 | null;
/**
* The location of the original file for a diff upload request. Must be filled in if responding to an upload start notification.
*/
originalObject?: Schema$GdataCompositeMedia;
}
/**
* Backend response for a Diff get version response. For details on the Scotty Diff protocol, visit http://go/scotty-diff-protocol.
*/
export interface Schema$GdataDiffVersionResponse {
/**
* The total size of the server object.
*/
objectSizeBytes?: string | null;
/**
* The version of the object stored at the server.
*/
objectVersion?: string | null;
}
/**
* Parameters specific to media downloads.
*/
export interface Schema$GdataDownloadParameters {
/**
* 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?: boolean | null;
/**
* Determining whether or not Apiary should skip the inclusion of any Content-Range header on its response to Scotty.
*/
ignoreRange?: boolean | null;
}
/**
* A reference to data stored on the filesystem, on GFS or in blobstore.
*/
export interface Schema$GdataMedia {
/**
* 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 | null;
/**
* Use object_id instead.
*/
bigstoreObjectRef?: string | null;
/**
* 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 | null;
/**
* Blobstore v2 info, set if reference_type is BLOBSTORE_REF and it refers to a v2 blob.
*/
blobstore2Info?: Schema$GdataBlobstore2Info;
/**
* 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?: Schema$GdataCompositeMedia[];
/**
* MIME type of the data
*/
contentType?: string | null;
/**
* Extended content type information provided for Scotty uploads.
*/
contentTypeInfo?: Schema$GdataContentTypeInfo;
/**
* 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 | null;
/**
* 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?: number | null;
/**
* Set if reference_type is DIFF_CHECKSUMS_RESPONSE.
*/
diffChecksumsResponse?: Schema$GdataDiffChecksumsResponse;
/**
* Set if reference_type is DIFF_DOWNLOAD_RESPONSE.
*/
diffDownloadResponse?: Schema$GdataDiffDownloadResponse;
/**
* Set if reference_type is DIFF_UPLOAD_REQUEST.
*/
diffUploadRequest?: Schema$GdataDiffUploadRequest;
/**
* Set if reference_type is DIFF_UPLOAD_RESPONSE.
*/
diffUploadResponse?: Schema$GdataDiffUploadResponse;
/**
* Set if reference_type is DIFF_VERSION_RESPONSE.
*/
diffVersionResponse?: Schema$GdataDiffVersionResponse;
/**
* Parameters for a media download.
*/
downloadParameters?: Schema$GdataDownloadParameters;
/**
* Original file name
*/
filename?: string | null;
/**
* 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 | null;
/**
* 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?: boolean | null;
/**
* Media data, set if reference_type is INLINE
*/
inline?: string | null;
/**
* |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?: boolean | null;
/**
* Size of the data, in bytes
*/
length?: string | null;
/**
* Scotty-provided MD5 hash for an upload.
*/
md5Hash?: string | null;
/**
* Media id to forward to the operation GetMedia. Can be set if reference_type is GET_MEDIA.
*/
mediaId?: string | null;
/**
* Reference to a TI Blob, set if reference_type is BIGSTORE_REF.
*/
objectId?: Schema$GdataObjectId;
/**
* Path to the data, set if reference_type is PATH
*/
path?: string | null;
/**
* Describes what the field reference contains.
*/
referenceType?: string | null;
/**
* Scotty-provided SHA1 hash for an upload.
*/
sha1Hash?: string | null;
/**
* Scotty-provided SHA256 hash for an upload.
*/
sha256Hash?: string | null;
/**
* Time at which the media data was last updated, in milliseconds since UNIX epoch
*/
timestamp?: string | null;
/**
* A unique fingerprint/version id for the media data
*/
token?: string | null;
}
/**
* 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.
*/
export interface Schema$GdataObjectId {
/**
* The name of the bucket to which this object belongs.
*/
bucketName?: string | null;
/**
* 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?: string | null;
/**
* The name of the object.
*/
objectName?: string | null;
}
/**
* `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.
*/
export interface Schema$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[] | null;
/**
* Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field.
*/
bucketOptions?: Schema$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 | null;
/**
* Must be in increasing order of `value` field.
*/
exemplars?: Schema$GoogleApiDistributionExemplar[];
/**
* The arithmetic mean of the values in the population. If `count` is zero then this field must be zero.
*/
mean?: number | null;
/**
* If specified, contains the range of the population values. The field must not be present if the `count` is zero.
*/
range?: Schema$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 | null;
}
/**
* `BucketOptions` describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. `BucketOptions` does not include the number of values in each bucket. A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i \> 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.
*/
export interface Schema$GoogleApiDistributionBucketOptions {
/**
* The explicit buckets.
*/
explicitBuckets?: Schema$GoogleApiDistributionBucketOptionsExplicit;
/**
* The exponential buckets.
*/
exponentialBuckets?: Schema$GoogleApiDistributionBucketOptionsExponential;
/**
* The linear bucket.
*/
linearBuckets?: Schema$GoogleApiDistributionBucketOptionsLinear;
}
/**
* Specifies a set of buckets with arbitrary widths. There are `size(bounds) + 1` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): bounds[i] Lower bound (1 <= i < N); bounds[i - 1] The `bounds` field must contain at least one element. If `bounds` has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.
*/
export interface Schema$GoogleApiDistributionBucketOptionsExplicit {
/**
* The values must be monotonically increasing.
*/
bounds?: number[] | null;
}
/**
* Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket. There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)).
*/
export interface Schema$GoogleApiDistributionBucketOptionsExponential {
/**
* Must be greater than 1.
*/
growthFactor?: number | null;
/**
* Must be greater than 0.
*/
numFiniteBuckets?: number | null;
/**
* Must be greater than 0.
*/
scale?: number | null;
}
/**
* Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket. There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)).
*/
export interface Schema$GoogleApiDistributionBucketOptionsLinear {
/**
* Must be greater than 0.
*/
numFiniteBuckets?: number | null;
/**
* Lower bound of the first bucket.
*/
offset?: number | null;
/**
* Must be greater than 0.
*/
width?: number | null;
}
/**
* Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc.
*/
export interface Schema$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<{
[key: string]: any;
}> | null;
/**
* The observation (sampling) time of the above value.
*/
timestamp?: string | null;
/**
* Value of the exemplar point. This value determines to which bucket the exemplar belongs.
*/
value?: number | null;
}
/**
* The range of the population values.
*/
export interface Schema$GoogleApiDistributionRange {
/**
* The maximum of the population values.
*/
max?: number | null;
/**
* The minimum of the population values.
*/
min?: number | null;
}
/**
* Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; \} service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); \} Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); \} Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
*/
export interface Schema$GoogleApiHttpBody {
/**
* The HTTP Content-Type header value specifying the content type of the body.
*/
contentType?: string | null;
/**
* The HTTP request/response body as raw binary.
*/
data?: string | null;
/**
* Application specific response metadata. Must be set in the first response for streaming APIs.
*/
extensions?: Array<{
[key: string]: any;
}> | null;
}
/**
* A specific metric, identified by specifying values for all of the labels of a `MetricDescriptor`.
*/
export interface Schema$GoogleApiMetric {
/**
* The set of label values that uniquely identify this metric. All labels listed in the `MetricDescriptor` must be assigned values.
*/
labels?: {
[key: string]: string;
} | null;
/**
* An existing metric type, see google.api.MetricDescriptor. For example, `custom.googleapis.com/invoice/paid/amount`.
*/
type?: string | null;
}
/**
* An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The `type` field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the `labels` field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for `"gce_instance"` has labels `"project_id"`, `"instance_id"` and `"zone"`: { "type": "gce_instance", "labels": { "project_id": "my-project", "instance_id": "12345678901234", "zone": "us-central1-a" \}\}
*/
export interface Schema$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?: {
[key: string]: string;
} | null;
/**
* 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 | null;
}
/**
* Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message.
*/
export interface Schema$GoogleApiMonitoredResourceMetadata {
/**
* Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Google, including "machine_image", "vpc", "subnet_id", "security_group", "name", etc. System label values can be only strings, Boolean values, or a list of strings. For example: { "name": "my-test-instance", "security_group": ["a", "b", "c"], "spot_instance": false \}
*/
systemLabels?: {
[key: string]: any;
} | null;
/**
* Output only. A map of user-defined metadata labels.
*/
userLabels?: {
[key: string]: string;
} | null;
}
/**
* The error payload that is populated on LRO sync APIs, including the following: * `google.cloud.discoveryengine.v1main.DataConnectorService.SetUpDataConnector` * `google.cloud.discoveryengine.v1main.DataConnectorService.StartConnectorRun`
*/
export interface Schema$GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext {
/**
* The full resource name of the Connector Run. Format: `projects/x/locations/x/collections/x/dataConnector/connectorRuns/x`. The `connector_run_id` is system-generated.
*/
connectorRun?: string | null;
/**
* The full resource name of the DataConnector. Format: `projects/x/locations/x/collections/x/dataConnector`.
*/
dataConnector?: string | null;
/**
* The time when the connector run ended.
*/
endTime?: string | null;
/**
* The entity to sync for the connector run.
*/
entity?: string | null;
/**
* The operation resource name of the LRO to sync the connector.
*/
operation?: string | null;
/**
* The time when the connector run started.
*/
startTime?: string | null;
/**
* The type of sync run. Can be one of the following: * `FULL` * `INCREMENTAL`
*/
syncType?: string | null;
}
/**
* A description of the context in which an error occurred.
*/
export interface Schema$GoogleCloudDiscoveryengineLoggingErrorContext {
/**
* The HTTP request which was processed when the error was triggered.
*/
httpRequest?: Schema$GoogleCloudDiscoveryengineLoggingHttpRequestContext;
/**
* The location in the source code where the decision was made to report the error, usually the place where it was logged.
*/
reportLocation?: Schema$GoogleCloudDiscoveryengineLoggingSourceLocation;
}
/**
* An error log which is reported to the Error Reporting system.
*/
export interface Schema$GoogleCloudDiscoveryengineLoggingErrorLog {
/**
* The error payload that is populated on LRO connector sync APIs.
*/
connectorRunPayload?: Schema$GoogleCloudDiscoveryengineLoggingConnectorRunErrorContext;
/**
* A description of the context in which the error occurred.
*/
context?: Schema$GoogleCloudDiscoveryengineLoggingErrorContext;
/**
* The error payload that is populated on LRO import APIs.
*/
importPayload?: Schema$GoogleCloudDiscoveryengineLoggingImportErrorContext;
/**
* A message describing the error.
*/
message?: string | null;
/**
* The API request payload, represented as a protocol buffer. Most API request types are supported—for example: * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.DocumentService.CreateDocumentRequest` * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEventRequest`
*/
requestPayload?: {
[key: string]: any;
} | null;
/**
* The API response payload, represented as a protocol buffer. This is used to log some "soft errors", where the response is valid but we consider there are some quality issues like unjoined events. The following API responses are supported, and no PII is included: * `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend` * `google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEvent` * `google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent`
*/
responsePayload?: {
[key: string]: any;
} | null;
/**
* The service context in which this error has occurred.
*/
serviceContext?: Schema$GoogleCloudDiscoveryengineLoggingServiceContext;
/**
* The RPC status associated with the error log.
*/
status?: Schema$GoogleRpcStatus;
}
/**
* HTTP request data that is related to a reported error.
*/
export interface Schema$GoogleCloudDiscoveryengineLoggingHttpRequestContext {
/**
* The HTTP response status code for the request.
*/
responseStatusCode?: number | null;
}
/**
* The error payload that is populated on LRO import APIs, including the following: * `google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments` * `google.cloud.discoveryengine.v1alpha.UserEventService.ImportUserEvents`
*/
export interface Schema$GoogleCloudDiscoveryengineLoggingImportErrorContext {
/**
* The detailed content which caused the error on importing a document.
*/
document?: string | null;
/**
* Google Cloud Storage file path of the import source. Can be set for batch operation error.
*/
gcsPath?: string | null;
/**
* Line number of the content in file. Should be empty for permission or batch operation error.
*/
lineNumber?: string | null;
/**
* The operation resource name of the LRO.
*/
operation?: string | null;
/**
* The detailed content which caused the error on importing a user event.
*/
userEvent?: string | null;
}
/**
* Describes a running service that sends errors.
*/
export interface Schema$GoogleCloudDiscoveryengineLoggingServiceContext {
/**
* An identifier of the service—for example, `discoveryengine.googleapis.com`.
*/
service?: string | null;
}
/**
* Indicates a location in the source code of the service for which errors are reported.
*/
export interface Schema$GoogleCloudDiscoveryengineLoggingSourceLocation {
/**
* Human-readable name of a function or method—for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`.
*/
functionName?: string | null;
}
/**
* Configuration data for advance site search.
*/
export interface Schema$GoogleCloudDiscoveryengineV1AdvancedSiteSearchConfig {
/**
* If set true, automatic refresh is disabled for the DataStore.
*/
disableAutomaticRefresh?: boolean | null;
/**
* If set true, initial indexing is disabled for the DataStore.
*/
disableInitialIndex?: boolean | null;
}
/**
* Access Control Configuration.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAclConfig {
/**
* Identity provider config.
*/
idpConfig?: Schema$GoogleCloudDiscoveryengineV1alphaIdpConfig;
/**
* Immutable. The full resource name of the acl configuration. Format: `projects/{project\}/locations/{location\}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
*/
name?: string | null;
}
/**
* Request message for the DataConnectorService.AcquireAccessToken method.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAcquireAccessTokenRequest {
}
/**
* Response message for the DataConnectorService.AcquireAccessToken method.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAcquireAccessTokenResponse {
/**
* The created access token.
*/
accessToken?: string | null;
/**
* Info about the stored refresh token used to create the access token.
*/
refreshTokenInfo?: Schema$GoogleCloudDiscoveryengineV1alphaRefreshTokenInfo;
}
/**
* Informations to support actions on the connector.
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaActionConfig {
/**
* Required. Params needed to support actions in the format of (Key, Value) pairs. Required parameters for sources that support OAUTH, i.e. `gmail`, `google_calendar`, `jira`, `workday`, `salesforce`, `confluence`: * Key: `client_id` * Value: type STRING. The client ID for the service provider to identify your application. * Key: `client_secret` * Value:type STRING. The client secret generated by the application's authorization server.
*/
actionParams?: {
[key: string]: any;
} | null;
/**
* Output only. The connector contains the necessary parameters and is configured to support actions.
*/
isActionConfigured?: boolean | null;
/**
* Optional. The Service Directory resource name (projects/x/locations/x/namespaces/x/services/x) representing a VPC network endpoint used to connect to the data source's `instance_uri`, defined in DataConnector.params. Required when VPC Service Controls are enabled.
*/
serviceName?: string | null;
}
/**
* Request message for CompletionService.AdvancedCompleteQuery method. .
*/
export interface Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequest {
/**
* Optional. Specification to boost suggestions matching the condition.
*/
boostSpec?: Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestBoostSpec;
/**
* Optional. Experiment ids for this request.
*/
experimentIds?: string[] | null;
/**
* Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.
*/
includeTailSuggestions?: boolean | null;
/**
* Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. The query can not be empty for most of the suggestion types. If it is empty, an `INVALID_ARGUMENT` error is returned. The exception is when the suggestion_types contains only the type `RECENT_SEARCH`, the query can be an empty string. The is called "zero prefix" feature, which returns user's recently searched queries given the empty query.
*/
query?: string | null;
/**
* Specifies the autocomplete query model, which only applies to the QUERY SuggestionType. This overrides any model specified in the Configuration \> Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.
*/
queryModel?: string | null;
/**
* Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment.
*/
suggestionTypes?: string[] | null;
/**
* Optional. Specification of each suggestion type.
*/
suggestionTypeSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaAdvancedCompleteQueryRequestSuggestionTypeSpec[];
/**
* Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info.
*/
userInfo?: Schema$GoogleCloudDiscoveryengineV1alphaUserInfo;
/**
* A unique identifier for tracking visitors. For example, this could be imple