pubsubLite

import { pubsubLite } from "https://googleapis.deno.dev/v1/pubsublite:v1.ts";

class pubsubLite {

constructor(client?: CredentialsClient, baseUrl?: string);

async adminProjectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>;

async adminProjectsLocationsOperationsDelete(name: string): Promise<Empty>;

async adminProjectsLocationsOperationsGet(name: string): Promise<Operation>;

async adminProjectsLocationsOperationsList(name: string, opts?: AdminProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>;

async adminProjectsLocationsReservationsCreate(

parent: string,

req: Reservation,

opts?: AdminProjectsLocationsReservationsCreateOptions,

): Promise<Reservation>;

async adminProjectsLocationsReservationsDelete(name: string): Promise<Empty>;

async adminProjectsLocationsReservationsGet(name: string): Promise<Reservation>;

async adminProjectsLocationsReservationsList(parent: string, opts?: AdminProjectsLocationsReservationsListOptions): Promise<ListReservationsResponse>;

async adminProjectsLocationsReservationsPatch(

req: Reservation,

opts?: AdminProjectsLocationsReservationsPatchOptions,

): Promise<Reservation>;

async adminProjectsLocationsReservationsTopicsList(name: string, opts?: AdminProjectsLocationsReservationsTopicsListOptions): Promise<ListReservationTopicsResponse>;

async adminProjectsLocationsSubscriptionsCreate(

parent: string,

req: Subscription,

opts?: AdminProjectsLocationsSubscriptionsCreateOptions,

): Promise<Subscription>;

async adminProjectsLocationsSubscriptionsDelete(name: string): Promise<Empty>;

async adminProjectsLocationsSubscriptionsGet(name: string): Promise<Subscription>;

async adminProjectsLocationsSubscriptionsList(parent: string, opts?: AdminProjectsLocationsSubscriptionsListOptions): Promise<ListSubscriptionsResponse>;

async adminProjectsLocationsSubscriptionsPatch(

req: Subscription,

opts?: AdminProjectsLocationsSubscriptionsPatchOptions,

): Promise<Subscription>;

async adminProjectsLocationsSubscriptionsSeek(name: string, req: SeekSubscriptionRequest): Promise<Operation>;

async adminProjectsLocationsTopicsCreate(

parent: string,

req: Topic,

opts?: AdminProjectsLocationsTopicsCreateOptions,

): Promise<Topic>;

async adminProjectsLocationsTopicsDelete(name: string): Promise<Empty>;

async adminProjectsLocationsTopicsGet(name: string): Promise<Topic>;

async adminProjectsLocationsTopicsGetPartitions(name: string): Promise<TopicPartitions>;

async adminProjectsLocationsTopicsList(parent: string, opts?: AdminProjectsLocationsTopicsListOptions): Promise<ListTopicsResponse>;

async adminProjectsLocationsTopicsPatch(

req: Topic,

opts?: AdminProjectsLocationsTopicsPatchOptions,

): Promise<Topic>;

async adminProjectsLocationsTopicsSubscriptionsList(name: string, opts?: AdminProjectsLocationsTopicsSubscriptionsListOptions): Promise<ListTopicSubscriptionsResponse>;

async cursorProjectsLocationsSubscriptionsCommitCursor(subscription: string, req: CommitCursorRequest): Promise<CommitCursorResponse>;

async cursorProjectsLocationsSubscriptionsCursorsList(parent: string, opts?: CursorProjectsLocationsSubscriptionsCursorsListOptions): Promise<ListPartitionCursorsResponse>;

async topicStatsProjectsLocationsTopicsComputeHeadCursor(topic: string, req: ComputeHeadCursorRequest): Promise<ComputeHeadCursorResponse>;

async topicStatsProjectsLocationsTopicsComputeMessageStats(topic: string, req: ComputeMessageStatsRequest): Promise<ComputeMessageStatsResponse>;

async topicStatsProjectsLocationsTopicsComputeTimeCursor(topic: string, req: ComputeTimeCursorRequest): Promise<ComputeTimeCursorResponse>;

}

§Constructors

new pubsubLite(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

adminProjectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>

[src]

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

adminProjectsLocationsOperationsDelete(name: string): Promise<Empty>

[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

adminProjectsLocationsOperationsGet(name: string): Promise<Operation>

[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

adminProjectsLocationsOperationsList(name: string, opts?: AdminProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

adminProjectsLocationsReservationsCreate(parent: string, req: Reservation, opts?: AdminProjectsLocationsReservationsCreateOptions): Promise<Reservation>

[src]

Creates a new reservation.

@param parent

Required. The parent location in which to create the reservation. Structured like projects/{project_number}/locations/{location}.

adminProjectsLocationsReservationsDelete(name: string): Promise<Empty>

[src]

Deletes the specified reservation.

@param name

Required. The name of the reservation to delete. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}

adminProjectsLocationsReservationsGet(name: string): Promise<Reservation>

[src]

Returns the reservation configuration.

@param name

Required. The name of the reservation whose configuration to return. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}

adminProjectsLocationsReservationsList(parent: string, opts?: AdminProjectsLocationsReservationsListOptions): Promise<ListReservationsResponse>

[src]

Returns the list of reservations for the given project.

@param parent

Required. The parent whose reservations are to be listed. Structured like projects/{project_number}/locations/{location}.

adminProjectsLocationsReservationsPatch(name: string, req: Reservation, opts?: AdminProjectsLocationsReservationsPatchOptions): Promise<Reservation>

[src]

Updates properties of the specified reservation.

@param name

The name of the reservation. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}

adminProjectsLocationsReservationsTopicsList(name: string, opts?: AdminProjectsLocationsReservationsTopicsListOptions): Promise<ListReservationTopicsResponse>

[src]

Lists the topics attached to the specified reservation.

@param name

Required. The name of the reservation whose topics to list. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}

adminProjectsLocationsSubscriptionsCreate(parent: string, req: Subscription, opts?: AdminProjectsLocationsSubscriptionsCreateOptions): Promise<Subscription>

[src]

Creates a new subscription.

@param parent

Required. The parent location in which to create the subscription. Structured like projects/{project_number}/locations/{location}.

adminProjectsLocationsSubscriptionsDelete(name: string): Promise<Empty>

[src]

Deletes the specified subscription.

@param name

Required. The name of the subscription to delete.

adminProjectsLocationsSubscriptionsGet(name: string): Promise<Subscription>

[src]

Returns the subscription configuration.

@param name

Required. The name of the subscription whose configuration to return.

adminProjectsLocationsSubscriptionsList(parent: string, opts?: AdminProjectsLocationsSubscriptionsListOptions): Promise<ListSubscriptionsResponse>

[src]

Returns the list of subscriptions for the given project.

@param parent

Required. The parent whose subscriptions are to be listed. Structured like projects/{project_number}/locations/{location}.

adminProjectsLocationsSubscriptionsPatch(name: string, req: Subscription, opts?: AdminProjectsLocationsSubscriptionsPatchOptions): Promise<Subscription>

[src]

Updates properties of the specified subscription.

@param name

The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id}

adminProjectsLocationsSubscriptionsSeek(name: string, req: SeekSubscriptionRequest): Promise<Operation>

[src]

Performs an out-of-band seek for a subscription to a specified target, which may be timestamps or named positions within the message backlog. Seek translates these targets to cursors for each partition and orchestrates subscribers to start consuming messages from these seek cursors. If an operation is returned, the seek has been registered and subscribers will eventually receive messages from the seek cursors (i.e. eventual consistency), as long as they are using a minimum supported client library version and not a system that tracks cursors independently of Pub/Sub Lite (e.g. Apache Beam, Dataflow, Spark). The seek operation will fail for unsupported clients. If clients would like to know when subscribers react to the seek (or not), they can poll the operation. The seek operation will succeed and complete once subscribers are ready to receive messages from the seek cursors for all partitions of the topic. This means that the seek operation will not complete until all subscribers come online. If the previous seek operation has not yet completed, it will be aborted and the new invocation of seek will supersede it.

@param name

Required. The name of the subscription to seek.

adminProjectsLocationsTopicsCreate(parent: string, req: Topic, opts?: AdminProjectsLocationsTopicsCreateOptions): Promise<Topic>

[src]

Creates a new topic.

@param parent

Required. The parent location in which to create the topic. Structured like projects/{project_number}/locations/{location}.

adminProjectsLocationsTopicsDelete(name: string): Promise<Empty>

[src]

Deletes the specified topic.

@param name

Required. The name of the topic to delete.

adminProjectsLocationsTopicsGet(name: string): Promise<Topic>

[src]

Returns the topic configuration.

@param name

Required. The name of the topic whose configuration to return.

adminProjectsLocationsTopicsGetPartitions(name: string): Promise<TopicPartitions>

[src]

Returns the partition information for the requested topic.

@param name

Required. The topic whose partition information to return.

adminProjectsLocationsTopicsList(parent: string, opts?: AdminProjectsLocationsTopicsListOptions): Promise<ListTopicsResponse>

[src]

Returns the list of topics for the given project.

@param parent

Required. The parent whose topics are to be listed. Structured like projects/{project_number}/locations/{location}.

adminProjectsLocationsTopicsPatch(name: string, req: Topic, opts?: AdminProjectsLocationsTopicsPatchOptions): Promise<Topic>

[src]

Updates properties of the specified topic.

@param name

The name of the topic. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id}

adminProjectsLocationsTopicsSubscriptionsList(name: string, opts?: AdminProjectsLocationsTopicsSubscriptionsListOptions): Promise<ListTopicSubscriptionsResponse>

[src]

Lists the subscriptions attached to the specified topic.

@param name

Required. The name of the topic whose subscriptions to list.

cursorProjectsLocationsSubscriptionsCommitCursor(subscription: string, req: CommitCursorRequest): Promise<CommitCursorResponse>

[src]

Updates the committed cursor.

@param subscription

The subscription for which to update the cursor.

cursorProjectsLocationsSubscriptionsCursorsList(parent: string, opts?: CursorProjectsLocationsSubscriptionsCursorsListOptions): Promise<ListPartitionCursorsResponse>

[src]

Returns all committed cursor information for a subscription.

@param parent

Required. The subscription for which to retrieve cursors. Structured like projects/{project_number}/locations/{location}/subscriptions/{subscription_id}.

topicStatsProjectsLocationsTopicsComputeHeadCursor(topic: string, req: ComputeHeadCursorRequest): Promise<ComputeHeadCursorResponse>

[src]

Compute the head cursor for the partition. The head cursor's offset is guaranteed to be less than or equal to all messages which have not yet been acknowledged as published, and greater than the offset of any message whose publish has already been acknowledged. It is zero if there have never been messages in the partition.

@param topic

Required. The topic for which we should compute the head cursor.

topicStatsProjectsLocationsTopicsComputeMessageStats(topic: string, req: ComputeMessageStatsRequest): Promise<ComputeMessageStatsResponse>

[src]

Compute statistics about a range of messages in a given topic and partition.

@param topic

Required. The topic for which we should compute message stats.

topicStatsProjectsLocationsTopicsComputeTimeCursor(topic: string, req: ComputeTimeCursorRequest): Promise<ComputeTimeCursorResponse>

[src]

Compute the corresponding cursor for a publish or event time in a topic partition.

@param topic

Required. The topic for which we should compute the cursor.