tana-google-cloud-pubsub
Version:
Cloud Pub/Sub Client Library for Node.js
1,035 lines (859 loc) • 652 kB
TypeScript
// Copyright 2023 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 pubsub. */
namespace pubsub {
/** Namespace v1. */
namespace v1 {
/** Represents a Publisher */
class Publisher extends $protobuf.rpc.Service {
/**
* Constructs a new Publisher 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 Publisher 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): Publisher;
/**
* Calls CreateTopic.
* @param request Topic message or plain object
* @param callback Node-style callback called with the error, if any, and Topic
*/
public createTopic(request: google.pubsub.v1.ITopic, callback: google.pubsub.v1.Publisher.CreateTopicCallback): void;
/**
* Calls CreateTopic.
* @param request Topic message or plain object
* @returns Promise
*/
public createTopic(request: google.pubsub.v1.ITopic): Promise<google.pubsub.v1.Topic>;
/**
* Calls UpdateTopic.
* @param request UpdateTopicRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Topic
*/
public updateTopic(request: google.pubsub.v1.IUpdateTopicRequest, callback: google.pubsub.v1.Publisher.UpdateTopicCallback): void;
/**
* Calls UpdateTopic.
* @param request UpdateTopicRequest message or plain object
* @returns Promise
*/
public updateTopic(request: google.pubsub.v1.IUpdateTopicRequest): Promise<google.pubsub.v1.Topic>;
/**
* Calls Publish.
* @param request PublishRequest message or plain object
* @param callback Node-style callback called with the error, if any, and PublishResponse
*/
public publish(request: google.pubsub.v1.IPublishRequest, callback: google.pubsub.v1.Publisher.PublishCallback): void;
/**
* Calls Publish.
* @param request PublishRequest message or plain object
* @returns Promise
*/
public publish(request: google.pubsub.v1.IPublishRequest): Promise<google.pubsub.v1.PublishResponse>;
/**
* Calls GetTopic.
* @param request GetTopicRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Topic
*/
public getTopic(request: google.pubsub.v1.IGetTopicRequest, callback: google.pubsub.v1.Publisher.GetTopicCallback): void;
/**
* Calls GetTopic.
* @param request GetTopicRequest message or plain object
* @returns Promise
*/
public getTopic(request: google.pubsub.v1.IGetTopicRequest): Promise<google.pubsub.v1.Topic>;
/**
* Calls ListTopics.
* @param request ListTopicsRequest message or plain object
* @param callback Node-style callback called with the error, if any, and ListTopicsResponse
*/
public listTopics(request: google.pubsub.v1.IListTopicsRequest, callback: google.pubsub.v1.Publisher.ListTopicsCallback): void;
/**
* Calls ListTopics.
* @param request ListTopicsRequest message or plain object
* @returns Promise
*/
public listTopics(request: google.pubsub.v1.IListTopicsRequest): Promise<google.pubsub.v1.ListTopicsResponse>;
/**
* Calls ListTopicSubscriptions.
* @param request ListTopicSubscriptionsRequest message or plain object
* @param callback Node-style callback called with the error, if any, and ListTopicSubscriptionsResponse
*/
public listTopicSubscriptions(request: google.pubsub.v1.IListTopicSubscriptionsRequest, callback: google.pubsub.v1.Publisher.ListTopicSubscriptionsCallback): void;
/**
* Calls ListTopicSubscriptions.
* @param request ListTopicSubscriptionsRequest message or plain object
* @returns Promise
*/
public listTopicSubscriptions(request: google.pubsub.v1.IListTopicSubscriptionsRequest): Promise<google.pubsub.v1.ListTopicSubscriptionsResponse>;
/**
* Calls ListTopicSnapshots.
* @param request ListTopicSnapshotsRequest message or plain object
* @param callback Node-style callback called with the error, if any, and ListTopicSnapshotsResponse
*/
public listTopicSnapshots(request: google.pubsub.v1.IListTopicSnapshotsRequest, callback: google.pubsub.v1.Publisher.ListTopicSnapshotsCallback): void;
/**
* Calls ListTopicSnapshots.
* @param request ListTopicSnapshotsRequest message or plain object
* @returns Promise
*/
public listTopicSnapshots(request: google.pubsub.v1.IListTopicSnapshotsRequest): Promise<google.pubsub.v1.ListTopicSnapshotsResponse>;
/**
* Calls DeleteTopic.
* @param request DeleteTopicRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Empty
*/
public deleteTopic(request: google.pubsub.v1.IDeleteTopicRequest, callback: google.pubsub.v1.Publisher.DeleteTopicCallback): void;
/**
* Calls DeleteTopic.
* @param request DeleteTopicRequest message or plain object
* @returns Promise
*/
public deleteTopic(request: google.pubsub.v1.IDeleteTopicRequest): Promise<google.protobuf.Empty>;
/**
* Calls DetachSubscription.
* @param request DetachSubscriptionRequest message or plain object
* @param callback Node-style callback called with the error, if any, and DetachSubscriptionResponse
*/
public detachSubscription(request: google.pubsub.v1.IDetachSubscriptionRequest, callback: google.pubsub.v1.Publisher.DetachSubscriptionCallback): void;
/**
* Calls DetachSubscription.
* @param request DetachSubscriptionRequest message or plain object
* @returns Promise
*/
public detachSubscription(request: google.pubsub.v1.IDetachSubscriptionRequest): Promise<google.pubsub.v1.DetachSubscriptionResponse>;
}
namespace Publisher {
/**
* Callback as used by {@link google.pubsub.v1.Publisher|createTopic}.
* @param error Error, if any
* @param [response] Topic
*/
type CreateTopicCallback = (error: (Error|null), response?: google.pubsub.v1.Topic) => void;
/**
* Callback as used by {@link google.pubsub.v1.Publisher|updateTopic}.
* @param error Error, if any
* @param [response] Topic
*/
type UpdateTopicCallback = (error: (Error|null), response?: google.pubsub.v1.Topic) => void;
/**
* Callback as used by {@link google.pubsub.v1.Publisher|publish}.
* @param error Error, if any
* @param [response] PublishResponse
*/
type PublishCallback = (error: (Error|null), response?: google.pubsub.v1.PublishResponse) => void;
/**
* Callback as used by {@link google.pubsub.v1.Publisher|getTopic}.
* @param error Error, if any
* @param [response] Topic
*/
type GetTopicCallback = (error: (Error|null), response?: google.pubsub.v1.Topic) => void;
/**
* Callback as used by {@link google.pubsub.v1.Publisher|listTopics}.
* @param error Error, if any
* @param [response] ListTopicsResponse
*/
type ListTopicsCallback = (error: (Error|null), response?: google.pubsub.v1.ListTopicsResponse) => void;
/**
* Callback as used by {@link google.pubsub.v1.Publisher|listTopicSubscriptions}.
* @param error Error, if any
* @param [response] ListTopicSubscriptionsResponse
*/
type ListTopicSubscriptionsCallback = (error: (Error|null), response?: google.pubsub.v1.ListTopicSubscriptionsResponse) => void;
/**
* Callback as used by {@link google.pubsub.v1.Publisher|listTopicSnapshots}.
* @param error Error, if any
* @param [response] ListTopicSnapshotsResponse
*/
type ListTopicSnapshotsCallback = (error: (Error|null), response?: google.pubsub.v1.ListTopicSnapshotsResponse) => void;
/**
* Callback as used by {@link google.pubsub.v1.Publisher|deleteTopic}.
* @param error Error, if any
* @param [response] Empty
*/
type DeleteTopicCallback = (error: (Error|null), response?: google.protobuf.Empty) => void;
/**
* Callback as used by {@link google.pubsub.v1.Publisher|detachSubscription}.
* @param error Error, if any
* @param [response] DetachSubscriptionResponse
*/
type DetachSubscriptionCallback = (error: (Error|null), response?: google.pubsub.v1.DetachSubscriptionResponse) => void;
}
/** Properties of a MessageStoragePolicy. */
interface IMessageStoragePolicy {
/** MessageStoragePolicy allowedPersistenceRegions */
allowedPersistenceRegions?: (string[]|null);
}
/** Represents a MessageStoragePolicy. */
class MessageStoragePolicy implements IMessageStoragePolicy {
/**
* Constructs a new MessageStoragePolicy.
* @param [properties] Properties to set
*/
constructor(properties?: google.pubsub.v1.IMessageStoragePolicy);
/** MessageStoragePolicy allowedPersistenceRegions. */
public allowedPersistenceRegions: string[];
/**
* Creates a new MessageStoragePolicy instance using the specified properties.
* @param [properties] Properties to set
* @returns MessageStoragePolicy instance
*/
public static create(properties?: google.pubsub.v1.IMessageStoragePolicy): google.pubsub.v1.MessageStoragePolicy;
/**
* Encodes the specified MessageStoragePolicy message. Does not implicitly {@link google.pubsub.v1.MessageStoragePolicy.verify|verify} messages.
* @param message MessageStoragePolicy message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.pubsub.v1.IMessageStoragePolicy, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified MessageStoragePolicy message, length delimited. Does not implicitly {@link google.pubsub.v1.MessageStoragePolicy.verify|verify} messages.
* @param message MessageStoragePolicy message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.pubsub.v1.IMessageStoragePolicy, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a MessageStoragePolicy message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns MessageStoragePolicy
* @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.pubsub.v1.MessageStoragePolicy;
/**
* Decodes a MessageStoragePolicy message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns MessageStoragePolicy
* @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.pubsub.v1.MessageStoragePolicy;
/**
* Verifies a MessageStoragePolicy 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 MessageStoragePolicy message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns MessageStoragePolicy
*/
public static fromObject(object: { [k: string]: any }): google.pubsub.v1.MessageStoragePolicy;
/**
* Creates a plain object from a MessageStoragePolicy message. Also converts values to other types if specified.
* @param message MessageStoragePolicy
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.pubsub.v1.MessageStoragePolicy, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this MessageStoragePolicy to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for MessageStoragePolicy
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a SchemaSettings. */
interface ISchemaSettings {
/** SchemaSettings schema */
schema?: (string|null);
/** SchemaSettings encoding */
encoding?: (google.pubsub.v1.Encoding|keyof typeof google.pubsub.v1.Encoding|null);
/** SchemaSettings firstRevisionId */
firstRevisionId?: (string|null);
/** SchemaSettings lastRevisionId */
lastRevisionId?: (string|null);
}
/** Represents a SchemaSettings. */
class SchemaSettings implements ISchemaSettings {
/**
* Constructs a new SchemaSettings.
* @param [properties] Properties to set
*/
constructor(properties?: google.pubsub.v1.ISchemaSettings);
/** SchemaSettings schema. */
public schema: string;
/** SchemaSettings encoding. */
public encoding: (google.pubsub.v1.Encoding|keyof typeof google.pubsub.v1.Encoding);
/** SchemaSettings firstRevisionId. */
public firstRevisionId: string;
/** SchemaSettings lastRevisionId. */
public lastRevisionId: string;
/**
* Creates a new SchemaSettings instance using the specified properties.
* @param [properties] Properties to set
* @returns SchemaSettings instance
*/
public static create(properties?: google.pubsub.v1.ISchemaSettings): google.pubsub.v1.SchemaSettings;
/**
* Encodes the specified SchemaSettings message. Does not implicitly {@link google.pubsub.v1.SchemaSettings.verify|verify} messages.
* @param message SchemaSettings message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.pubsub.v1.ISchemaSettings, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified SchemaSettings message, length delimited. Does not implicitly {@link google.pubsub.v1.SchemaSettings.verify|verify} messages.
* @param message SchemaSettings message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.pubsub.v1.ISchemaSettings, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a SchemaSettings message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns SchemaSettings
* @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.pubsub.v1.SchemaSettings;
/**
* Decodes a SchemaSettings message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns SchemaSettings
* @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.pubsub.v1.SchemaSettings;
/**
* Verifies a SchemaSettings 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 SchemaSettings message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns SchemaSettings
*/
public static fromObject(object: { [k: string]: any }): google.pubsub.v1.SchemaSettings;
/**
* Creates a plain object from a SchemaSettings message. Also converts values to other types if specified.
* @param message SchemaSettings
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.pubsub.v1.SchemaSettings, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this SchemaSettings to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for SchemaSettings
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a Topic. */
interface ITopic {
/** Topic name */
name?: (string|null);
/** Topic labels */
labels?: ({ [k: string]: string }|null);
/** Topic messageStoragePolicy */
messageStoragePolicy?: (google.pubsub.v1.IMessageStoragePolicy|null);
/** Topic kmsKeyName */
kmsKeyName?: (string|null);
/** Topic schemaSettings */
schemaSettings?: (google.pubsub.v1.ISchemaSettings|null);
/** Topic satisfiesPzs */
satisfiesPzs?: (boolean|null);
/** Topic messageRetentionDuration */
messageRetentionDuration?: (google.protobuf.IDuration|null);
}
/** Represents a Topic. */
class Topic implements ITopic {
/**
* Constructs a new Topic.
* @param [properties] Properties to set
*/
constructor(properties?: google.pubsub.v1.ITopic);
/** Topic name. */
public name: string;
/** Topic labels. */
public labels: { [k: string]: string };
/** Topic messageStoragePolicy. */
public messageStoragePolicy?: (google.pubsub.v1.IMessageStoragePolicy|null);
/** Topic kmsKeyName. */
public kmsKeyName: string;
/** Topic schemaSettings. */
public schemaSettings?: (google.pubsub.v1.ISchemaSettings|null);
/** Topic satisfiesPzs. */
public satisfiesPzs: boolean;
/** Topic messageRetentionDuration. */
public messageRetentionDuration?: (google.protobuf.IDuration|null);
/**
* Creates a new Topic instance using the specified properties.
* @param [properties] Properties to set
* @returns Topic instance
*/
public static create(properties?: google.pubsub.v1.ITopic): google.pubsub.v1.Topic;
/**
* Encodes the specified Topic message. Does not implicitly {@link google.pubsub.v1.Topic.verify|verify} messages.
* @param message Topic message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.pubsub.v1.ITopic, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified Topic message, length delimited. Does not implicitly {@link google.pubsub.v1.Topic.verify|verify} messages.
* @param message Topic message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.pubsub.v1.ITopic, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a Topic message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns Topic
* @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.pubsub.v1.Topic;
/**
* Decodes a Topic message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns Topic
* @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.pubsub.v1.Topic;
/**
* Verifies a Topic 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 Topic message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns Topic
*/
public static fromObject(object: { [k: string]: any }): google.pubsub.v1.Topic;
/**
* Creates a plain object from a Topic message. Also converts values to other types if specified.
* @param message Topic
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.pubsub.v1.Topic, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this Topic to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for Topic
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a PubsubMessage. */
interface IPubsubMessage {
/** PubsubMessage data */
data?: (Uint8Array|string|null);
/** PubsubMessage attributes */
attributes?: ({ [k: string]: string }|null);
/** PubsubMessage messageId */
messageId?: (string|null);
/** PubsubMessage publishTime */
publishTime?: (google.protobuf.ITimestamp|null);
/** PubsubMessage orderingKey */
orderingKey?: (string|null);
}
/** Represents a PubsubMessage. */
class PubsubMessage implements IPubsubMessage {
/**
* Constructs a new PubsubMessage.
* @param [properties] Properties to set
*/
constructor(properties?: google.pubsub.v1.IPubsubMessage);
/** PubsubMessage data. */
public data: (Uint8Array|string);
/** PubsubMessage attributes. */
public attributes: { [k: string]: string };
/** PubsubMessage messageId. */
public messageId: string;
/** PubsubMessage publishTime. */
public publishTime?: (google.protobuf.ITimestamp|null);
/** PubsubMessage orderingKey. */
public orderingKey: string;
/**
* Creates a new PubsubMessage instance using the specified properties.
* @param [properties] Properties to set
* @returns PubsubMessage instance
*/
public static create(properties?: google.pubsub.v1.IPubsubMessage): google.pubsub.v1.PubsubMessage;
/**
* Encodes the specified PubsubMessage message. Does not implicitly {@link google.pubsub.v1.PubsubMessage.verify|verify} messages.
* @param message PubsubMessage message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.pubsub.v1.IPubsubMessage, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified PubsubMessage message, length delimited. Does not implicitly {@link google.pubsub.v1.PubsubMessage.verify|verify} messages.
* @param message PubsubMessage message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.pubsub.v1.IPubsubMessage, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a PubsubMessage message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns PubsubMessage
* @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.pubsub.v1.PubsubMessage;
/**
* Decodes a PubsubMessage message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns PubsubMessage
* @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.pubsub.v1.PubsubMessage;
/**
* Verifies a PubsubMessage 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 PubsubMessage message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns PubsubMessage
*/
public static fromObject(object: { [k: string]: any }): google.pubsub.v1.PubsubMessage;
/**
* Creates a plain object from a PubsubMessage message. Also converts values to other types if specified.
* @param message PubsubMessage
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.pubsub.v1.PubsubMessage, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this PubsubMessage to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for PubsubMessage
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a GetTopicRequest. */
interface IGetTopicRequest {
/** GetTopicRequest topic */
topic?: (string|null);
}
/** Represents a GetTopicRequest. */
class GetTopicRequest implements IGetTopicRequest {
/**
* Constructs a new GetTopicRequest.
* @param [properties] Properties to set
*/
constructor(properties?: google.pubsub.v1.IGetTopicRequest);
/** GetTopicRequest topic. */
public topic: string;
/**
* Creates a new GetTopicRequest instance using the specified properties.
* @param [properties] Properties to set
* @returns GetTopicRequest instance
*/
public static create(properties?: google.pubsub.v1.IGetTopicRequest): google.pubsub.v1.GetTopicRequest;
/**
* Encodes the specified GetTopicRequest message. Does not implicitly {@link google.pubsub.v1.GetTopicRequest.verify|verify} messages.
* @param message GetTopicRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.pubsub.v1.IGetTopicRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified GetTopicRequest message, length delimited. Does not implicitly {@link google.pubsub.v1.GetTopicRequest.verify|verify} messages.
* @param message GetTopicRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.pubsub.v1.IGetTopicRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a GetTopicRequest message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns GetTopicRequest
* @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.pubsub.v1.GetTopicRequest;
/**
* Decodes a GetTopicRequest message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns GetTopicRequest
* @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.pubsub.v1.GetTopicRequest;
/**
* Verifies a GetTopicRequest 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 GetTopicRequest message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns GetTopicRequest
*/
public static fromObject(object: { [k: string]: any }): google.pubsub.v1.GetTopicRequest;
/**
* Creates a plain object from a GetTopicRequest message. Also converts values to other types if specified.
* @param message GetTopicRequest
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.pubsub.v1.GetTopicRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this GetTopicRequest to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for GetTopicRequest
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of an UpdateTopicRequest. */
interface IUpdateTopicRequest {
/** UpdateTopicRequest topic */
topic?: (google.pubsub.v1.ITopic|null);
/** UpdateTopicRequest updateMask */
updateMask?: (google.protobuf.IFieldMask|null);
}
/** Represents an UpdateTopicRequest. */
class UpdateTopicRequest implements IUpdateTopicRequest {
/**
* Constructs a new UpdateTopicRequest.
* @param [properties] Properties to set
*/
constructor(properties?: google.pubsub.v1.IUpdateTopicRequest);
/** UpdateTopicRequest topic. */
public topic?: (google.pubsub.v1.ITopic|null);
/** UpdateTopicRequest updateMask. */
public updateMask?: (google.protobuf.IFieldMask|null);
/**
* Creates a new UpdateTopicRequest instance using the specified properties.
* @param [properties] Properties to set
* @returns UpdateTopicRequest instance
*/
public static create(properties?: google.pubsub.v1.IUpdateTopicRequest): google.pubsub.v1.UpdateTopicRequest;
/**
* Encodes the specified UpdateTopicRequest message. Does not implicitly {@link google.pubsub.v1.UpdateTopicRequest.verify|verify} messages.
* @param message UpdateTopicRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.pubsub.v1.IUpdateTopicRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified UpdateTopicRequest message, length delimited. Does not implicitly {@link google.pubsub.v1.UpdateTopicRequest.verify|verify} messages.
* @param message UpdateTopicRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.pubsub.v1.IUpdateTopicRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes an UpdateTopicRequest message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns UpdateTopicRequest
* @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.pubsub.v1.UpdateTopicRequest;
/**
* Decodes an UpdateTopicRequest message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns UpdateTopicRequest
* @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.pubsub.v1.UpdateTopicRequest;
/**
* Verifies an UpdateTopicRequest 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 UpdateTopicRequest message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns UpdateTopicRequest
*/
public static fromObject(object: { [k: string]: any }): google.pubsub.v1.UpdateTopicRequest;
/**
* Creates a plain object from an UpdateTopicRequest message. Also converts values to other types if specified.
* @param message UpdateTopicRequest
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.pubsub.v1.UpdateTopicRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this UpdateTopicRequest to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for UpdateTopicRequest
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a PublishRequest. */
interface IPublishRequest {
/** PublishRequest topic */
topic?: (string|null);
/** PublishRequest messages */
messages?: (google.pubsub.v1.IPubsubMessage[]|null);
}
/** Represents a PublishRequest. */
class PublishRequest implements IPublishRequest {
/**
* Constructs a new PublishRequest.
* @param [properties] Properties to set
*/
constructor(properties?: google.pubsub.v1.IPublishRequest);
/** PublishRequest topic. */
public topic: string;
/** PublishRequest messages. */
public messages: google.pubsub.v1.IPubsubMessage[];
/**
* Creates a new PublishRequest instance using the specified properties.
* @param [properties] Properties to set
* @returns PublishRequest instance
*/
public static create(properties?: google.pubsub.v1.IPublishRequest): google.pubsub.v1.PublishRequest;
/**
* Encodes the specified PublishRequest message. Does not implicitly {@link google.pubsub.v1.PublishRequest.verify|verify} messages.
* @param message PublishRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.pubsub.v1.IPublishRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified PublishRequest message, length delimited. Does not implicitly {@link google.pubsub.v1.PublishRequest.verify|verify} messages.
* @param message PublishRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.pubsub.v1.IPublishRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a PublishRequest message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns PublishRequest
* @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.pubsub.v1.PublishRequest;
/**
* Decodes a PublishRequest message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns PublishRequest
* @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.pubsub.v1.PublishRequest;
/**
* Verifies a PublishRequest 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 PublishRequest message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns PublishRequest
*/
public static fromObject(object: { [k: string]: any }): google.pubsub.v1.PublishRequest;
/**
* Creates a plain object from a PublishRequest message. Also converts values to other types if specified.
* @param message PublishRequest
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.pubsub.v1.PublishRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this PublishRequest to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for PublishRequest
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a PublishResponse. */
interface IPublishResponse {
/** PublishResponse messageIds */
messageIds?: (string[]|null);
}
/** Represents a PublishResponse. */
class PublishResponse implements IPublishResponse {
/**
* Constructs a new PublishResponse.
* @param [properties] Properties to set
*/
constructor(properties?: google.pubsub.v1.IPublishResponse);
/** PublishResponse messageIds. */
public messageIds: string[];
/**
* Creates a new PublishResponse instance using the specified properties.
* @param [properties] Properties to set
* @returns PublishResponse instance
*/
public static create(properties?: google.pubsub.v1.IPublishResponse): google.pubsub.v1.PublishResponse;
/**
* Encodes the specified PublishResponse