UNPKG

@google-cloud/retail

Version:
900 lines (748 loc) 4.94 MB
// Copyright 2026 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. import type {protobuf as $protobuf} from "google-gax"; import Long = require("long"); /** Namespace google. */ export namespace google { /** Namespace cloud. */ namespace cloud { /** Namespace retail. */ namespace retail { /** Namespace v2. */ namespace v2 { /** Represents an AnalyticsService */ class AnalyticsService extends $protobuf.rpc.Service { /** * Constructs a new AnalyticsService service. * @param rpcImpl RPC implementation * @param [requestDelimited=false] Whether requests are length-delimited * @param [responseDelimited=false] Whether responses are length-delimited */ constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean); /** * Creates new AnalyticsService service using the specified rpc implementation. * @param rpcImpl RPC implementation * @param [requestDelimited=false] Whether requests are length-delimited * @param [responseDelimited=false] Whether responses are length-delimited * @returns RPC service. Useful where requests and/or responses are streamed. */ public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): AnalyticsService; /** * Calls ExportAnalyticsMetrics. * @param request ExportAnalyticsMetricsRequest message or plain object * @param callback Node-style callback called with the error, if any, and Operation */ public exportAnalyticsMetrics(request: google.cloud.retail.v2.IExportAnalyticsMetricsRequest, callback: google.cloud.retail.v2.AnalyticsService.ExportAnalyticsMetricsCallback): void; /** * Calls ExportAnalyticsMetrics. * @param request ExportAnalyticsMetricsRequest message or plain object * @returns Promise */ public exportAnalyticsMetrics(request: google.cloud.retail.v2.IExportAnalyticsMetricsRequest): Promise<google.longrunning.Operation>; } namespace AnalyticsService { /** * Callback as used by {@link google.cloud.retail.v2.AnalyticsService|exportAnalyticsMetrics}. * @param error Error, if any * @param [response] Operation */ type ExportAnalyticsMetricsCallback = (error: (Error|null), response?: google.longrunning.Operation) => void; } /** Properties of an OutputConfig. */ interface IOutputConfig { /** OutputConfig gcsDestination */ gcsDestination?: (google.cloud.retail.v2.OutputConfig.IGcsDestination|null); /** OutputConfig bigqueryDestination */ bigqueryDestination?: (google.cloud.retail.v2.OutputConfig.IBigQueryDestination|null); } /** Represents an OutputConfig. */ class OutputConfig implements IOutputConfig { /** * Constructs a new OutputConfig. * @param [properties] Properties to set */ constructor(properties?: google.cloud.retail.v2.IOutputConfig); /** OutputConfig gcsDestination. */ public gcsDestination?: (google.cloud.retail.v2.OutputConfig.IGcsDestination|null); /** OutputConfig bigqueryDestination. */ public bigqueryDestination?: (google.cloud.retail.v2.OutputConfig.IBigQueryDestination|null); /** OutputConfig destination. */ public destination?: ("gcsDestination"|"bigqueryDestination"); /** * Creates a new OutputConfig instance using the specified properties. * @param [properties] Properties to set * @returns OutputConfig instance */ public static create(properties?: google.cloud.retail.v2.IOutputConfig): google.cloud.retail.v2.OutputConfig; /** * Encodes the specified OutputConfig message. Does not implicitly {@link google.cloud.retail.v2.OutputConfig.verify|verify} messages. * @param message OutputConfig message or plain object to encode * @param [writer] Writer to encode to * @returns Writer */ public static encode(message: google.cloud.retail.v2.IOutputConfig, writer?: $protobuf.Writer): $protobuf.Writer; /** * Encodes the specified OutputConfig message, length delimited. Does not implicitly {@link google.cloud.retail.v2.OutputConfig.verify|verify} messages. * @param message OutputConfig message or plain object to encode * @param [writer] Writer to encode to * @returns Writer */ public static encodeDelimited(message: google.cloud.retail.v2.IOutputConfig, writer?: $protobuf.Writer): $protobuf.Writer; /** * Decodes an OutputConfig message from the specified reader or buffer. * @param reader Reader or buffer to decode from * @param [length] Message length if known beforehand * @returns OutputConfig * @throws {Error} If the payload is not a reader or valid buffer * @throws {$protobuf.util.ProtocolError} If required fields are missing */ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.retail.v2.OutputConfig; /** * Decodes an OutputConfig message from the specified reader or buffer, length delimited. * @param reader Reader or buffer to decode from * @returns OutputConfig * @throws {Error} If the payload is not a reader or valid buffer * @throws {$protobuf.util.ProtocolError} If required fields are missing */ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.retail.v2.OutputConfig; /** * Verifies an OutputConfig message. * @param message Plain object to verify * @returns `null` if valid, otherwise the reason why it is not */ public static verify(message: { [k: string]: any }): (string|null); /** * Creates an OutputConfig message from a plain object. Also converts values to their respective internal types. * @param object Plain object * @returns OutputConfig */ public static fromObject(object: { [k: string]: any }): google.cloud.retail.v2.OutputConfig; /** * Creates a plain object from an OutputConfig message. Also converts values to other types if specified. * @param message OutputConfig * @param [options] Conversion options * @returns Plain object */ public static toObject(message: google.cloud.retail.v2.OutputConfig, options?: $protobuf.IConversionOptions): { [k: string]: any }; /** * Converts this OutputConfig to JSON. * @returns JSON object */ public toJSON(): { [k: string]: any }; /** * Gets the default type url for OutputConfig * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") * @returns The default type url */ public static getTypeUrl(typeUrlPrefix?: string): string; } namespace OutputConfig { /** Properties of a GcsDestination. */ interface IGcsDestination { /** GcsDestination outputUriPrefix */ outputUriPrefix?: (string|null); } /** Represents a GcsDestination. */ class GcsDestination implements IGcsDestination { /** * Constructs a new GcsDestination. * @param [properties] Properties to set */ constructor(properties?: google.cloud.retail.v2.OutputConfig.IGcsDestination); /** GcsDestination outputUriPrefix. */ public outputUriPrefix: string; /** * Creates a new GcsDestination instance using the specified properties. * @param [properties] Properties to set * @returns GcsDestination instance */ public static create(properties?: google.cloud.retail.v2.OutputConfig.IGcsDestination): google.cloud.retail.v2.OutputConfig.GcsDestination; /** * Encodes the specified GcsDestination message. Does not implicitly {@link google.cloud.retail.v2.OutputConfig.GcsDestination.verify|verify} messages. * @param message GcsDestination message or plain object to encode * @param [writer] Writer to encode to * @returns Writer */ public static encode(message: google.cloud.retail.v2.OutputConfig.IGcsDestination, writer?: $protobuf.Writer): $protobuf.Writer; /** * Encodes the specified GcsDestination message, length delimited. Does not implicitly {@link google.cloud.retail.v2.OutputConfig.GcsDestination.verify|verify} messages. * @param message GcsDestination message or plain object to encode * @param [writer] Writer to encode to * @returns Writer */ public static encodeDelimited(message: google.cloud.retail.v2.OutputConfig.IGcsDestination, writer?: $protobuf.Writer): $protobuf.Writer; /** * Decodes a GcsDestination message from the specified reader or buffer. * @param reader Reader or buffer to decode from * @param [length] Message length if known beforehand * @returns GcsDestination * @throws {Error} If the payload is not a reader or valid buffer * @throws {$protobuf.util.ProtocolError} If required fields are missing */ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.retail.v2.OutputConfig.GcsDestination; /** * Decodes a GcsDestination message from the specified reader or buffer, length delimited. * @param reader Reader or buffer to decode from * @returns GcsDestination * @throws {Error} If the payload is not a reader or valid buffer * @throws {$protobuf.util.ProtocolError} If required fields are missing */ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.retail.v2.OutputConfig.GcsDestination; /** * Verifies a GcsDestination message. * @param message Plain object to verify * @returns `null` if valid, otherwise the reason why it is not */ public static verify(message: { [k: string]: any }): (string|null); /** * Creates a GcsDestination message from a plain object. Also converts values to their respective internal types. * @param object Plain object * @returns GcsDestination */ public static fromObject(object: { [k: string]: any }): google.cloud.retail.v2.OutputConfig.GcsDestination; /** * Creates a plain object from a GcsDestination message. Also converts values to other types if specified. * @param message GcsDestination * @param [options] Conversion options * @returns Plain object */ public static toObject(message: google.cloud.retail.v2.OutputConfig.GcsDestination, options?: $protobuf.IConversionOptions): { [k: string]: any }; /** * Converts this GcsDestination to JSON. * @returns JSON object */ public toJSON(): { [k: string]: any }; /** * Gets the default type url for GcsDestination * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") * @returns The default type url */ public static getTypeUrl(typeUrlPrefix?: string): string; } /** Properties of a BigQueryDestination. */ interface IBigQueryDestination { /** BigQueryDestination datasetId */ datasetId?: (string|null); /** BigQueryDestination tableIdPrefix */ tableIdPrefix?: (string|null); /** BigQueryDestination tableType */ tableType?: (string|null); } /** Represents a BigQueryDestination. */ class BigQueryDestination implements IBigQueryDestination { /** * Constructs a new BigQueryDestination. * @param [properties] Properties to set */ constructor(properties?: google.cloud.retail.v2.OutputConfig.IBigQueryDestination); /** BigQueryDestination datasetId. */ public datasetId: string; /** BigQueryDestination tableIdPrefix. */ public tableIdPrefix: string; /** BigQueryDestination tableType. */ public tableType: string; /** * Creates a new BigQueryDestination instance using the specified properties. * @param [properties] Properties to set * @returns BigQueryDestination instance */ public static create(properties?: google.cloud.retail.v2.OutputConfig.IBigQueryDestination): google.cloud.retail.v2.OutputConfig.BigQueryDestination; /** * Encodes the specified BigQueryDestination message. Does not implicitly {@link google.cloud.retail.v2.OutputConfig.BigQueryDestination.verify|verify} messages. * @param message BigQueryDestination message or plain object to encode * @param [writer] Writer to encode to * @returns Writer */ public static encode(message: google.cloud.retail.v2.OutputConfig.IBigQueryDestination, writer?: $protobuf.Writer): $protobuf.Writer; /** * Encodes the specified BigQueryDestination message, length delimited. Does not implicitly {@link google.cloud.retail.v2.OutputConfig.BigQueryDestination.verify|verify} messages. * @param message BigQueryDestination message or plain object to encode * @param [writer] Writer to encode to * @returns Writer */ public static encodeDelimited(message: google.cloud.retail.v2.OutputConfig.IBigQueryDestination, writer?: $protobuf.Writer): $protobuf.Writer; /** * Decodes a BigQueryDestination message from the specified reader or buffer. * @param reader Reader or buffer to decode from * @param [length] Message length if known beforehand * @returns BigQueryDestination * @throws {Error} If the payload is not a reader or valid buffer * @throws {$protobuf.util.ProtocolError} If required fields are missing */ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.retail.v2.OutputConfig.BigQueryDestination; /** * Decodes a BigQueryDestination message from the specified reader or buffer, length delimited. * @param reader Reader or buffer to decode from * @returns BigQueryDestination * @throws {Error} If the payload is not a reader or valid buffer * @throws {$protobuf.util.ProtocolError} If required fields are missing */ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.retail.v2.OutputConfig.BigQueryDestination; /** * Verifies a BigQueryDestination message. * @param message Plain object to verify * @returns `null` if valid, otherwise the reason why it is not */ public static verify(message: { [k: string]: any }): (string|null); /** * Creates a BigQueryDestination message from a plain object. Also converts values to their respective internal types. * @param object Plain object * @returns BigQueryDestination */ public static fromObject(object: { [k: string]: any }): google.cloud.retail.v2.OutputConfig.BigQueryDestination; /** * Creates a plain object from a BigQueryDestination message. Also converts values to other types if specified. * @param message BigQueryDestination * @param [options] Conversion options * @returns Plain object */ public static toObject(message: google.cloud.retail.v2.OutputConfig.BigQueryDestination, options?: $protobuf.IConversionOptions): { [k: string]: any }; /** * Converts this BigQueryDestination to JSON. * @returns JSON object */ public toJSON(): { [k: string]: any }; /** * Gets the default type url for BigQueryDestination * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") * @returns The default type url */ public static getTypeUrl(typeUrlPrefix?: string): string; } } /** Properties of an ExportErrorsConfig. */ interface IExportErrorsConfig { /** ExportErrorsConfig gcsPrefix */ gcsPrefix?: (string|null); } /** Represents an ExportErrorsConfig. */ class ExportErrorsConfig implements IExportErrorsConfig { /** * Constructs a new ExportErrorsConfig. * @param [properties] Properties to set */ constructor(properties?: google.cloud.retail.v2.IExportErrorsConfig); /** ExportErrorsConfig gcsPrefix. */ public gcsPrefix?: (string|null); /** ExportErrorsConfig destination. */ public destination?: "gcsPrefix"; /** * Creates a new ExportErrorsConfig instance using the specified properties. * @param [properties] Properties to set * @returns ExportErrorsConfig instance */ public static create(properties?: google.cloud.retail.v2.IExportErrorsConfig): google.cloud.retail.v2.ExportErrorsConfig; /** * Encodes the specified ExportErrorsConfig message. Does not implicitly {@link google.cloud.retail.v2.ExportErrorsConfig.verify|verify} messages. * @param message ExportErrorsConfig message or plain object to encode * @param [writer] Writer to encode to * @returns Writer */ public static encode(message: google.cloud.retail.v2.IExportErrorsConfig, writer?: $protobuf.Writer): $protobuf.Writer; /** * Encodes the specified ExportErrorsConfig message, length delimited. Does not implicitly {@link google.cloud.retail.v2.ExportErrorsConfig.verify|verify} messages. * @param message ExportErrorsConfig message or plain object to encode * @param [writer] Writer to encode to * @returns Writer */ public static encodeDelimited(message: google.cloud.retail.v2.IExportErrorsConfig, writer?: $protobuf.Writer): $protobuf.Writer; /** * Decodes an ExportErrorsConfig message from the specified reader or buffer. * @param reader Reader or buffer to decode from * @param [length] Message length if known beforehand * @returns ExportErrorsConfig * @throws {Error} If the payload is not a reader or valid buffer * @throws {$protobuf.util.ProtocolError} If required fields are missing */ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.retail.v2.ExportErrorsConfig; /** * Decodes an ExportErrorsConfig message from the specified reader or buffer, length delimited. * @param reader Reader or buffer to decode from * @returns ExportErrorsConfig * @throws {Error} If the payload is not a reader or valid buffer * @throws {$protobuf.util.ProtocolError} If required fields are missing */ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.retail.v2.ExportErrorsConfig; /** * Verifies an ExportErrorsConfig message. * @param message Plain object to verify * @returns `null` if valid, otherwise the reason why it is not */ public static verify(message: { [k: string]: any }): (string|null); /** * Creates an ExportErrorsConfig message from a plain object. Also converts values to their respective internal types. * @param object Plain object * @returns ExportErrorsConfig */ public static fromObject(object: { [k: string]: any }): google.cloud.retail.v2.ExportErrorsConfig; /** * Creates a plain object from an ExportErrorsConfig message. Also converts values to other types if specified. * @param message ExportErrorsConfig * @param [options] Conversion options * @returns Plain object */ public static toObject(message: google.cloud.retail.v2.ExportErrorsConfig, options?: $protobuf.IConversionOptions): { [k: string]: any }; /** * Converts this ExportErrorsConfig to JSON. * @returns JSON object */ public toJSON(): { [k: string]: any }; /** * Gets the default type url for ExportErrorsConfig * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") * @returns The default type url */ public static getTypeUrl(typeUrlPrefix?: string): string; } /** Properties of an ExportAnalyticsMetricsRequest. */ interface IExportAnalyticsMetricsRequest { /** ExportAnalyticsMetricsRequest catalog */ catalog?: (string|null); /** ExportAnalyticsMetricsRequest outputConfig */ outputConfig?: (google.cloud.retail.v2.IOutputConfig|null); /** ExportAnalyticsMetricsRequest filter */ filter?: (string|null); } /** Represents an ExportAnalyticsMetricsRequest. */ class ExportAnalyticsMetricsRequest implements IExportAnalyticsMetricsRequest { /** * Constructs a new ExportAnalyticsMetricsRequest. * @param [properties] Properties to set */ constructor(properties?: google.cloud.retail.v2.IExportAnalyticsMetricsRequest); /** ExportAnalyticsMetricsRequest catalog. */ public catalog: string; /** ExportAnalyticsMetricsRequest outputConfig. */ public outputConfig?: (google.cloud.retail.v2.IOutputConfig|null); /** ExportAnalyticsMetricsRequest filter. */ public filter: string; /** * Creates a new ExportAnalyticsMetricsRequest instance using the specified properties. * @param [properties] Properties to set * @returns ExportAnalyticsMetricsRequest instance */ public static create(properties?: google.cloud.retail.v2.IExportAnalyticsMetricsRequest): google.cloud.retail.v2.ExportAnalyticsMetricsRequest; /** * Encodes the specified ExportAnalyticsMetricsRequest message. Does not implicitly {@link google.cloud.retail.v2.ExportAnalyticsMetricsRequest.verify|verify} messages. * @param message ExportAnalyticsMetricsRequest message or plain object to encode * @param [writer] Writer to encode to * @returns Writer */ public static encode(message: google.cloud.retail.v2.IExportAnalyticsMetricsRequest, writer?: $protobuf.Writer): $protobuf.Writer; /** * Encodes the specified ExportAnalyticsMetricsRequest message, length delimited. Does not implicitly {@link google.cloud.retail.v2.ExportAnalyticsMetricsRequest.verify|verify} messages. * @param message ExportAnalyticsMetricsRequest message or plain object to encode * @param [writer] Writer to encode to * @returns Writer */ public static encodeDelimited(message: google.cloud.retail.v2.IExportAnalyticsMetricsRequest, writer?: $protobuf.Writer): $protobuf.Writer; /** * Decodes an ExportAnalyticsMetricsRequest message from the specified reader or buffer. * @param reader Reader or buffer to decode from * @param [length] Message length if known beforehand * @returns ExportAnalyticsMetricsRequest * @throws {Error} If the payload is not a reader or valid buffer * @throws {$protobuf.util.ProtocolError} If required fields are missing */ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.retail.v2.ExportAnalyticsMetricsRequest; /** * Decodes an ExportAnalyticsMetricsRequest message from the specified reader or buffer, length delimited. * @param reader Reader or buffer to decode from * @returns ExportAnalyticsMetricsRequest * @throws {Error} If the payload is not a reader or valid buffer * @throws {$protobuf.util.ProtocolError} If required fields are missing */ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.retail.v2.ExportAnalyticsMetricsRequest; /** * Verifies an ExportAnalyticsMetricsRequest message. * @param message Plain object to verify * @returns `null` if valid, otherwise the reason why it is not */ public static verify(message: { [k: string]: any }): (string|null); /** * Creates an ExportAnalyticsMetricsRequest message from a plain object. Also converts values to their respective internal types. * @param object Plain object * @returns ExportAnalyticsMetricsRequest */ public static fromObject(object: { [k: string]: any }): google.cloud.retail.v2.ExportAnalyticsMetricsRequest; /** * Creates a plain object from an ExportAnalyticsMetricsRequest message. Also converts values to other types if specified. * @param message ExportAnalyticsMetricsRequest * @param [options] Conversion options * @returns Plain object */ public static toObject(message: google.cloud.retail.v2.ExportAnalyticsMetricsRequest, options?: $protobuf.IConversionOptions): { [k: string]: any }; /** * Converts this ExportAnalyticsMetricsRequest to JSON. * @returns JSON object */ public toJSON(): { [k: string]: any }; /** * Gets the default type url for ExportAnalyticsMetricsRequest * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") * @returns The default type url */ public static getTypeUrl(typeUrlPrefix?: string): string; } /** Properties of an ExportMetadata. */ interface IExportMetadata { /** ExportMetadata createTime */ createTime?: (google.protobuf.ITimestamp|null); /** ExportMetadata updateTime */ updateTime?: (google.protobuf.ITimestamp|null); } /** Represents an ExportMetadata. */ class ExportMetadata implements IExportMetadata { /** * Constructs a new ExportMetadata. * @param [properties] Properties to set */ constructor(properties?: google.cloud.retail.v2.IExportMetadata); /** ExportMetadata createTime. */ public createTime?: (google.protobuf.ITimestamp|null); /** ExportMetadata updateTime. */ public updateTime?: (google.protobuf.ITimestamp|null); /** * Creates a new ExportMetadata instance using the specified properties. * @param [properties] Properties to set * @returns ExportMetadata instance */ public static create(properties?: google.cloud.retail.v2.IExportMetadata): google.cloud.retail.v2.ExportMetadata; /** * Encodes the specified ExportMetadata message. Does not implicitly {@link google.cloud.retail.v2.ExportMetadata.verify|verify} messages. * @param message ExportMetadata message or plain object to encode * @param [writer] Writer to encode to * @returns Writer */ public static encode(message: google.cloud.retail.v2.IExportMetadata, writer?: $protobuf.Writer): $protobuf.Writer; /** * Encodes the specified ExportMetadata message, length delimited. Does not implicitly {@link google.cloud.retail.v2.ExportMetadata.verify|verify} messages. * @param message ExportMetadata message or plain object to encode * @param [writer] Writer to encode to * @returns Writer */ public static encodeDelimited(message: google.cloud.retail.v2.IExportMetadata, writer?: $protobuf.Writer): $protobuf.Writer; /** * Decodes an ExportMetadata message from the specified reader or buffer. * @param reader Reader or buffer to decode from * @param [length] Message length if known beforehand * @returns ExportMetadata * @throws {Error} If the payload is not a reader or valid buffer * @throws {$protobuf.util.ProtocolError} If required fields are missing */ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.retail.v2.ExportMetadata; /** * Decodes an ExportMetadata message from the specified reader or buffer, length delimited. * @param reader Reader or buffer to decode from * @returns ExportMetadata * @throws {Error} If the payload is not a reader or valid buffer * @throws {$protobuf.util.ProtocolError} If required fields are missing */ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.retail.v2.ExportMetadata; /** * Verifies an ExportMetadata message. * @param message Plain object to verify * @returns `null` if valid, otherwise the reason why it is not */ public static verify(message: { [k: string]: any }): (string|null); /** * Creates an ExportMetadata message from a plain object. Also converts values to their respective internal types. * @param object Plain object * @returns ExportMetadata */ public static fromObject(object: { [k: string]: any }): google.cloud.retail.v2.ExportMetadata; /** * Creates a plain object from an ExportMetadata message. Also converts values to other types if specified. * @param message ExportMetadata * @param [options] Conversion options * @returns Plain object */ public static toObject(message: google.cloud.retail.v2.ExportMetadata, options?: $protobuf.IConversionOptions): { [k: string]: any }; /** * Converts this ExportMetadata to JSON. * @returns JSON object */ public toJSON(): { [k: string]: any }; /** * Gets the default type url for ExportMetadata * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") * @returns The default type url */ public static getTypeUrl(typeUrlPrefix?: string): string; } /** Properties of an ExportAnalyticsMetricsResponse. */ interface IExportAnalyticsMetricsResponse { /** ExportAnalyticsMetricsResponse errorSamples */ errorSamples?: (google.rpc.IStatus[]|null); /** ExportAnalyticsMetricsResponse errorsConfig */ errorsConfig?: (google.cloud.retail.v2.IExportErrorsConfig|null); /** ExportAnalyticsMetricsResponse outputResult */ outputResult?: (google.cloud.retail.v2.IOutputResult|null); } /** Represents an ExportAnalyticsMetricsResponse. */ class ExportAnalyticsMetricsResponse implements IExportAnalyticsMetricsResponse { /** * Constructs a new ExportAnalyticsMetricsResponse. * @param [properties] Properties to set */ constructor(properties?: google.cloud.retail.v2.IExportAnalyticsMetricsResponse); /** ExportAnalyticsMetricsResponse errorSamples. */ public errorSamples: google.rpc.IStatus[]; /** ExportAnalyticsMetricsResponse errorsConfig. */ public errorsConfig?: (google.cloud.retail.v2.IExportErrorsConfig|null); /** ExportAnalyticsMetricsResponse outputResult. */ public outputResult?: (google.cloud.retail.v2.IOutputResult|null); /** * Creates a new ExportAnalyticsMetricsResponse instance using the specified properties. * @param [properties] Properties to set * @returns ExportAnalyticsMetricsResponse instance */ public static create(properties?: google.cloud.retail.v2.IExportAnalyticsMetricsResponse): google.cloud.retail.v2.ExportAnalyticsMetricsResponse; /** * Encodes the specified ExportAnalyticsMetricsResponse message. Does not implicitly {@link google.cloud.retail.v2.ExportAnalyticsMetricsResponse.verify|verify} messages. * @param message ExportAnalyticsMetricsResponse message or plain object to encode * @param [writer] Writer to encode to * @returns Writer */ public static encode(message: google.cloud.retail.v2.IExportAnalyticsMetricsResponse, writer?: $protobuf.Writer): $protobuf.Writer; /** * Encodes the specified ExportAnalyticsMetricsResponse message, length delimited. Does not implicitly {@link google.cloud.retail.v2.ExportAnalyticsMetricsResponse.verify|verify} messages. * @param message ExportAnalyticsMetricsResponse message or plain object to encode * @param [writer] Writer to encode to * @returns Writer */ public static encodeDelimited(message: google.cloud.retail.v2.IExportAnalyticsMetricsResponse, writer?: $protobuf.Writer): $protobuf.Writer; /** * Decodes an ExportAnalyticsMetricsResponse message from the specified reader or buffer. * @param reader Reader or buffer to decode from * @param [length] Message length if known beforehand * @returns ExportAnalyticsMetricsResponse * @throws {Error} If the payload is not a reader or valid buffer * @throws {$protobuf.util.ProtocolError} If required fields are missing */ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.retail.v2.ExportAnalyticsMetricsResponse; /** * Decodes an ExportAnalyticsMetricsResponse message from the specified reader or buffer, length delimited. * @param reader Reader or buffer to decode from * @returns ExportAnalyticsMetricsResponse * @throws {Error} If the payload is not a reader or valid buffer * @throws {$protobuf.util.ProtocolError} If required fields are missing */ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.retail.v2.ExportAnalyticsMetricsResponse; /** * Verifies an ExportAnalyticsMetricsResponse message. * @param message Plain object to verify * @returns `null` if valid, otherwise the reason why it is not */ public static verify(message: { [k: string]: any }): (string|null); /** * Creates an ExportAnalyticsMetricsResponse message from a plain object. Also converts values to their respective internal types. * @param object Plain object * @returns ExportAnalyticsMetricsResponse */ public static fromObject(object: { [k: string]: any }): google.cloud.retail.v2.ExportAnalyticsMetricsResponse; /** * Creates a plain object from an ExportAnalyticsMetricsResponse message. Also converts values to other types if specified. * @param message ExportAnalyticsMetricsResponse * @param [options] Conversion options * @returns Plain object */ public static toObject(message: google.cloud.retail.v2.ExportAnalyticsMetricsResponse, options?: $protobuf.IConversionOptions): { [k: string]: any }; /** * Converts this ExportAnalyticsMetricsResponse to JSON. * @returns JSON object */ public toJSON(): { [k: string]: any }; /** * Gets the default type url for ExportAnalyticsMetricsResponse * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com") * @returns The default type url */ public static getTypeUrl(typeUrlPrefix?: string): string; } /** Properties of an OutputResult. */ interface IOutputResult { /** OutputResult bigqueryResult */ bigqueryResult?: (google.cloud.retail.v2.IBigQueryOutputResult[]|null); /** OutputResult gcsResult */ gcsResult?: (google.cloud.retail.v2.IGcsOutputResult[]|null); } /** Represents an OutputResult. */ class OutputResult implements IOutputResult { /** * Constructs a new OutputResult. * @param [properties] Properties to set */ constructor(properties?: google.cloud.retail.v2.IOutputResult); /** OutputResult bigqueryResult. */ public bigqueryResult: google.cloud.retail.v2.IBigQueryOutputResult[]; /** OutputResult gcsResult. */ public gcsResult: google.cloud.retail.v2.IGcsOutputResult[]; /** * Creates a new OutputResult instance using the specified properties. * @param [properties] Properties to set * @returns OutputResult instance */ public static create(properties?: google.cloud.retail.v2.IOutputResult): google.cloud.retail.v2.OutputResult; /** * Encodes the specified OutputResult message. Does not implicitly {@link google.cloud.retail.v2.OutputResult.verify|verify} messages. * @param message OutputResult message or plain object to encode * @param [writer] Writer to encode to * @returns Writer */ public static encode(message: google.cloud.retail.v2.IOutputResult, writer?: $protobuf.Writer): $protobuf.Writer; /** * Encodes the specified OutputResult message, length delimited. Does not implicitly {@link google.cloud.retail.v2.OutputResult.verify|verify} messages. * @param message OutputResult message or plain object to encode * @param [writer] Writer to encode to * @returns Writer */ public static encodeDelimited(message: google.cloud.retail.v2.IOutputResult, writer?: $protobuf.Writer): $protobuf.Writer; /** * Decodes an OutputResult message from the specified reader or buffer. * @param reader Reader or buffer to decode from * @param [length] Message length if known beforehand * @returns OutputResult * @throws {Error} If the payload is not a reader or valid buffer * @throws {$protobuf.util.ProtocolError} If required fields are missing */ public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.retail.v2.OutputResult; /** * Decodes an OutputResult message from the specified reader or buffer, length delimited. * @param reader Reader or buffer to decode from * @returns OutputResult * @throws {Error} If the payload is not a reader or valid buffer * @throws {$protobuf.util.ProtocolError} If required fields are missing */ public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.retail.v2.OutputResult; /** * Verifies an OutputResult message. * @param message Plain object to verify * @returns `null` if valid, otherwise the reason why it is not */ public static verify(message: { [k: string]: any }): (string|null); /** * Creates an OutputResult message from a plain object. Also converts values to their respective internal types. * @param object Plain object * @returns OutputResult */ public static fromObject(object: { [k: string]: any }): google.cloud.retail.v2.OutputResult; /** * Creates a plain object from an OutputResult message. Also converts values to other types if specified. * @param message OutputResult * @param [options] Conversion options * @returns Plain object */ public static toObject(message: google.cloud.retail.v2.OutputResult, options?: $protobuf.IConversionOptions): { [k: string]: any }; /**