Movatterモバイル変換


[0]ホーム

URL:


pubsublite

package
v0.257.0Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 2, 2025 License:BSD-3-ClauseImports:18Imported by:0

Details

Repository

github.com/googleapis/google-api-go-client

Links

Documentation

Overview

Package pubsublite provides access to the Pub/Sub Lite API.

For product documentation, see:https://cloud.google.com/pubsub/lite/docs

Library status

These client libraries are officially supported by Google. However, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany new features.

When possible, we recommend using our newer[Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/pubsublite/v1"...ctx := context.Background()pubsubliteService, err := pubsublite.NewService(ctx)

In this example, Google Application Default Credentials are used forauthentication. For information on how to create and obtain ApplicationDefault Credentials, seehttps://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support APIkeys), usegoogle.golang.org/api/option.WithAPIKey:

pubsubliteService, err := pubsublite.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuthflow, usegoogle.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}// ...token, err := config.Exchange(ctx, ...)pubsubliteService, err := pubsublite.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

Seegoogle.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (// See, edit, configure, and delete your Google Cloud data and see the email// address for your Google Account.CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform")

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

typeAdminProjectsLocationsOperationsCancelCalladded inv0.53.0

type AdminProjectsLocationsOperationsCancelCall struct {// contains filtered or unexported fields}

func (*AdminProjectsLocationsOperationsCancelCall)Contextadded inv0.53.0

Context sets the context to be used in this call's Do method.

func (*AdminProjectsLocationsOperationsCancelCall)Doadded inv0.53.0

Do executes the "pubsublite.admin.projects.locations.operations.cancel" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AdminProjectsLocationsOperationsCancelCall)Fieldsadded inv0.53.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AdminProjectsLocationsOperationsCancelCall)Headeradded inv0.53.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeAdminProjectsLocationsOperationsDeleteCalladded inv0.53.0

type AdminProjectsLocationsOperationsDeleteCall struct {// contains filtered or unexported fields}

func (*AdminProjectsLocationsOperationsDeleteCall)Contextadded inv0.53.0

Context sets the context to be used in this call's Do method.

func (*AdminProjectsLocationsOperationsDeleteCall)Doadded inv0.53.0

Do executes the "pubsublite.admin.projects.locations.operations.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AdminProjectsLocationsOperationsDeleteCall)Fieldsadded inv0.53.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AdminProjectsLocationsOperationsDeleteCall)Headeradded inv0.53.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeAdminProjectsLocationsOperationsGetCalladded inv0.53.0

type AdminProjectsLocationsOperationsGetCall struct {// contains filtered or unexported fields}

func (*AdminProjectsLocationsOperationsGetCall)Contextadded inv0.53.0

Context sets the context to be used in this call's Do method.

func (*AdminProjectsLocationsOperationsGetCall)Doadded inv0.53.0

Do executes the "pubsublite.admin.projects.locations.operations.get" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AdminProjectsLocationsOperationsGetCall)Fieldsadded inv0.53.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AdminProjectsLocationsOperationsGetCall)Headeradded inv0.53.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*AdminProjectsLocationsOperationsGetCall)IfNoneMatchadded inv0.53.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeAdminProjectsLocationsOperationsListCalladded inv0.53.0

type AdminProjectsLocationsOperationsListCall struct {// contains filtered or unexported fields}

func (*AdminProjectsLocationsOperationsListCall)Contextadded inv0.53.0

Context sets the context to be used in this call's Do method.

func (*AdminProjectsLocationsOperationsListCall)Doadded inv0.53.0

Do executes the "pubsublite.admin.projects.locations.operations.list" call.Any non-2xx status code is an error. Response headers are in either*ListOperationsResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*AdminProjectsLocationsOperationsListCall)Fieldsadded inv0.53.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AdminProjectsLocationsOperationsListCall)Filteradded inv0.53.0

Filter sets the optional parameter "filter": The standard list filter.

func (*AdminProjectsLocationsOperationsListCall)Headeradded inv0.53.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*AdminProjectsLocationsOperationsListCall)IfNoneMatchadded inv0.53.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*AdminProjectsLocationsOperationsListCall)PageSizeadded inv0.53.0

PageSize sets the optional parameter "pageSize": The standard list pagesize.

func (*AdminProjectsLocationsOperationsListCall)PageTokenadded inv0.53.0

PageToken sets the optional parameter "pageToken": The standard list pagetoken.

func (*AdminProjectsLocationsOperationsListCall)Pagesadded inv0.53.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

func (*AdminProjectsLocationsOperationsListCall)ReturnPartialSuccessadded inv0.253.0

ReturnPartialSuccess sets the optional parameter "returnPartialSuccess":When set to `true`, operations that are reachable are returned as normal,and those that are unreachable are returned in theListOperationsResponse.unreachable field. This can only be `true` whenreading across collections. For example, when `parent` is set to"projects/example/locations/-". This field is not supported by default andwill result in an `UNIMPLEMENTED` error if set unless explicitly documentedotherwise in service or product specific documentation.

typeAdminProjectsLocationsOperationsServiceadded inv0.53.0

type AdminProjectsLocationsOperationsService struct {// contains filtered or unexported fields}

funcNewAdminProjectsLocationsOperationsServiceadded inv0.53.0

func NewAdminProjectsLocationsOperationsService(s *Service) *AdminProjectsLocationsOperationsService

func (*AdminProjectsLocationsOperationsService)Canceladded inv0.53.0

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

- name: The name of the operation resource to be cancelled.

func (*AdminProjectsLocationsOperationsService)Deleteadded inv0.53.0

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

- name: The name of the operation resource to be deleted.

func (*AdminProjectsLocationsOperationsService)Getadded inv0.53.0

Get: Gets the latest state of a long-running operation. Clients can use thismethod to poll the operation result at intervals as recommended by the APIservice.

- name: The name of the operation resource.

func (*AdminProjectsLocationsOperationsService)Listadded inv0.53.0

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

- name: The name of the operation's parent resource.

typeAdminProjectsLocationsReservationsCreateCalladded inv0.57.0

type AdminProjectsLocationsReservationsCreateCall struct {// contains filtered or unexported fields}

func (*AdminProjectsLocationsReservationsCreateCall)Contextadded inv0.57.0

Context sets the context to be used in this call's Do method.

func (*AdminProjectsLocationsReservationsCreateCall)Doadded inv0.57.0

Do executes the "pubsublite.admin.projects.locations.reservations.create" call.Any non-2xx status code is an error. Response headers are in either*Reservation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AdminProjectsLocationsReservationsCreateCall)Fieldsadded inv0.57.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AdminProjectsLocationsReservationsCreateCall)Headeradded inv0.57.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*AdminProjectsLocationsReservationsCreateCall)ReservationIdadded inv0.57.0

ReservationId sets the optional parameter "reservationId": Required. The IDto use for the reservation, which will become the final component of thereservation's name. This value is structured like: `my-reservation-name`.

typeAdminProjectsLocationsReservationsDeleteCalladded inv0.57.0

type AdminProjectsLocationsReservationsDeleteCall struct {// contains filtered or unexported fields}

func (*AdminProjectsLocationsReservationsDeleteCall)Contextadded inv0.57.0

Context sets the context to be used in this call's Do method.

func (*AdminProjectsLocationsReservationsDeleteCall)Doadded inv0.57.0

Do executes the "pubsublite.admin.projects.locations.reservations.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AdminProjectsLocationsReservationsDeleteCall)Fieldsadded inv0.57.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AdminProjectsLocationsReservationsDeleteCall)Headeradded inv0.57.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeAdminProjectsLocationsReservationsGetCalladded inv0.57.0

type AdminProjectsLocationsReservationsGetCall struct {// contains filtered or unexported fields}

func (*AdminProjectsLocationsReservationsGetCall)Contextadded inv0.57.0

Context sets the context to be used in this call's Do method.

func (*AdminProjectsLocationsReservationsGetCall)Doadded inv0.57.0

Do executes the "pubsublite.admin.projects.locations.reservations.get" call.Any non-2xx status code is an error. Response headers are in either*Reservation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AdminProjectsLocationsReservationsGetCall)Fieldsadded inv0.57.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AdminProjectsLocationsReservationsGetCall)Headeradded inv0.57.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*AdminProjectsLocationsReservationsGetCall)IfNoneMatchadded inv0.57.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeAdminProjectsLocationsReservationsListCalladded inv0.57.0

type AdminProjectsLocationsReservationsListCall struct {// contains filtered or unexported fields}

func (*AdminProjectsLocationsReservationsListCall)Contextadded inv0.57.0

Context sets the context to be used in this call's Do method.

func (*AdminProjectsLocationsReservationsListCall)Doadded inv0.57.0

Do executes the "pubsublite.admin.projects.locations.reservations.list" call.Any non-2xx status code is an error. Response headers are in either*ListReservationsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*AdminProjectsLocationsReservationsListCall)Fieldsadded inv0.57.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AdminProjectsLocationsReservationsListCall)Headeradded inv0.57.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*AdminProjectsLocationsReservationsListCall)IfNoneMatchadded inv0.57.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*AdminProjectsLocationsReservationsListCall)PageSizeadded inv0.57.0

PageSize sets the optional parameter "pageSize": The maximum number ofreservations to return. The service may return fewer than this value. Ifunset or zero, all reservations for the parent will be returned.

func (*AdminProjectsLocationsReservationsListCall)PageTokenadded inv0.57.0

PageToken sets the optional parameter "pageToken": A page token, receivedfrom a previous `ListReservations` call. Provide this to retrieve thesubsequent page. When paginating, all other parameters provided to`ListReservations` must match the call that provided the page token.

func (*AdminProjectsLocationsReservationsListCall)Pagesadded inv0.57.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeAdminProjectsLocationsReservationsPatchCalladded inv0.57.0

type AdminProjectsLocationsReservationsPatchCall struct {// contains filtered or unexported fields}

func (*AdminProjectsLocationsReservationsPatchCall)Contextadded inv0.57.0

Context sets the context to be used in this call's Do method.

func (*AdminProjectsLocationsReservationsPatchCall)Doadded inv0.57.0

Do executes the "pubsublite.admin.projects.locations.reservations.patch" call.Any non-2xx status code is an error. Response headers are in either*Reservation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AdminProjectsLocationsReservationsPatchCall)Fieldsadded inv0.57.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AdminProjectsLocationsReservationsPatchCall)Headeradded inv0.57.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*AdminProjectsLocationsReservationsPatchCall)UpdateMaskadded inv0.57.0

UpdateMask sets the optional parameter "updateMask": Required. A maskspecifying the reservation fields to change.

typeAdminProjectsLocationsReservationsServiceadded inv0.57.0

type AdminProjectsLocationsReservationsService struct {Topics *AdminProjectsLocationsReservationsTopicsService// contains filtered or unexported fields}

funcNewAdminProjectsLocationsReservationsServiceadded inv0.57.0

func NewAdminProjectsLocationsReservationsService(s *Service) *AdminProjectsLocationsReservationsService

func (*AdminProjectsLocationsReservationsService)Createadded inv0.57.0

Create: Creates a new reservation.

  • parent: The parent location in which to create the reservation. Structuredlike `projects/{project_number}/locations/{location}`.

func (*AdminProjectsLocationsReservationsService)Deleteadded inv0.57.0

Delete: Deletes the specified reservation.

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

func (*AdminProjectsLocationsReservationsService)Getadded inv0.57.0

Get: Returns the reservation configuration.

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

func (*AdminProjectsLocationsReservationsService)Listadded inv0.57.0

List: Returns the list of reservations for the given project.

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

func (*AdminProjectsLocationsReservationsService)Patchadded inv0.57.0

Patch: Updates properties of the specified reservation.

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

typeAdminProjectsLocationsReservationsTopicsListCalladded inv0.57.0

type AdminProjectsLocationsReservationsTopicsListCall struct {// contains filtered or unexported fields}

func (*AdminProjectsLocationsReservationsTopicsListCall)Contextadded inv0.57.0

Context sets the context to be used in this call's Do method.

func (*AdminProjectsLocationsReservationsTopicsListCall)Doadded inv0.57.0

Do executes the "pubsublite.admin.projects.locations.reservations.topics.list" call.Any non-2xx status code is an error. Response headers are in either*ListReservationTopicsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*AdminProjectsLocationsReservationsTopicsListCall)Fieldsadded inv0.57.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AdminProjectsLocationsReservationsTopicsListCall)Headeradded inv0.57.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*AdminProjectsLocationsReservationsTopicsListCall)IfNoneMatchadded inv0.57.0

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*AdminProjectsLocationsReservationsTopicsListCall)PageSizeadded inv0.57.0

PageSize sets the optional parameter "pageSize": The maximum number oftopics to return. The service may return fewer than this value. If unset orzero, all topics for the given reservation will be returned.

func (*AdminProjectsLocationsReservationsTopicsListCall)PageTokenadded inv0.57.0

PageToken sets the optional parameter "pageToken": A page token, receivedfrom a previous `ListReservationTopics` call. Provide this to retrieve thesubsequent page. When paginating, all other parameters provided to`ListReservationTopics` must match the call that provided the page token.

func (*AdminProjectsLocationsReservationsTopicsListCall)Pagesadded inv0.57.0

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeAdminProjectsLocationsReservationsTopicsServiceadded inv0.57.0

type AdminProjectsLocationsReservationsTopicsService struct {// contains filtered or unexported fields}

funcNewAdminProjectsLocationsReservationsTopicsServiceadded inv0.57.0

func NewAdminProjectsLocationsReservationsTopicsService(s *Service) *AdminProjectsLocationsReservationsTopicsService

func (*AdminProjectsLocationsReservationsTopicsService)Listadded inv0.57.0

List: Lists the topics attached to the specified reservation.

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

typeAdminProjectsLocationsService

type AdminProjectsLocationsService struct {Operations *AdminProjectsLocationsOperationsServiceReservations *AdminProjectsLocationsReservationsServiceSubscriptions *AdminProjectsLocationsSubscriptionsServiceTopics *AdminProjectsLocationsTopicsService// contains filtered or unexported fields}

funcNewAdminProjectsLocationsService

func NewAdminProjectsLocationsService(s *Service) *AdminProjectsLocationsService

typeAdminProjectsLocationsSubscriptionsCreateCall

type AdminProjectsLocationsSubscriptionsCreateCall struct {// contains filtered or unexported fields}

func (*AdminProjectsLocationsSubscriptionsCreateCall)Context

Context sets the context to be used in this call's Do method.

func (*AdminProjectsLocationsSubscriptionsCreateCall)Do

Do executes the "pubsublite.admin.projects.locations.subscriptions.create" call.Any non-2xx status code is an error. Response headers are in either*Subscription.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AdminProjectsLocationsSubscriptionsCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AdminProjectsLocationsSubscriptionsCreateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*AdminProjectsLocationsSubscriptionsCreateCall)SkipBacklogadded inv0.43.0

SkipBacklog sets the optional parameter "skipBacklog": If true, the newlycreated subscription will only receive messages published after thesubscription was created. Otherwise, the entire message backlog will bereceived on the subscription. Defaults to false.

func (*AdminProjectsLocationsSubscriptionsCreateCall)SubscriptionId

SubscriptionId sets the optional parameter "subscriptionId": Required. TheID to use for the subscription, which will become the final component of thesubscription's name. This value is structured like: `my-sub-name`.

typeAdminProjectsLocationsSubscriptionsDeleteCall

type AdminProjectsLocationsSubscriptionsDeleteCall struct {// contains filtered or unexported fields}

func (*AdminProjectsLocationsSubscriptionsDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*AdminProjectsLocationsSubscriptionsDeleteCall)Do

Do executes the "pubsublite.admin.projects.locations.subscriptions.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AdminProjectsLocationsSubscriptionsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AdminProjectsLocationsSubscriptionsDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeAdminProjectsLocationsSubscriptionsGetCall

type AdminProjectsLocationsSubscriptionsGetCall struct {// contains filtered or unexported fields}

func (*AdminProjectsLocationsSubscriptionsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*AdminProjectsLocationsSubscriptionsGetCall)Do

Do executes the "pubsublite.admin.projects.locations.subscriptions.get" call.Any non-2xx status code is an error. Response headers are in either*Subscription.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AdminProjectsLocationsSubscriptionsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AdminProjectsLocationsSubscriptionsGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*AdminProjectsLocationsSubscriptionsGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeAdminProjectsLocationsSubscriptionsListCall

type AdminProjectsLocationsSubscriptionsListCall struct {// contains filtered or unexported fields}

func (*AdminProjectsLocationsSubscriptionsListCall)Context

Context sets the context to be used in this call's Do method.

func (*AdminProjectsLocationsSubscriptionsListCall)Do

Do executes the "pubsublite.admin.projects.locations.subscriptions.list" call.Any non-2xx status code is an error. Response headers are in either*ListSubscriptionsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*AdminProjectsLocationsSubscriptionsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AdminProjectsLocationsSubscriptionsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*AdminProjectsLocationsSubscriptionsListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*AdminProjectsLocationsSubscriptionsListCall)PageSize

PageSize sets the optional parameter "pageSize": The maximum number ofsubscriptions to return. The service may return fewer than this value. Ifunset or zero, all subscriptions for the parent will be returned.

func (*AdminProjectsLocationsSubscriptionsListCall)PageToken

PageToken sets the optional parameter "pageToken": A page token, receivedfrom a previous `ListSubscriptions` call. Provide this to retrieve thesubsequent page. When paginating, all other parameters provided to`ListSubscriptions` must match the call that provided the page token.

func (*AdminProjectsLocationsSubscriptionsListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeAdminProjectsLocationsSubscriptionsPatchCall

type AdminProjectsLocationsSubscriptionsPatchCall struct {// contains filtered or unexported fields}

func (*AdminProjectsLocationsSubscriptionsPatchCall)Context

Context sets the context to be used in this call's Do method.

func (*AdminProjectsLocationsSubscriptionsPatchCall)Do

Do executes the "pubsublite.admin.projects.locations.subscriptions.patch" call.Any non-2xx status code is an error. Response headers are in either*Subscription.ServerResponse.Header or (if a response was returned at all)in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AdminProjectsLocationsSubscriptionsPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AdminProjectsLocationsSubscriptionsPatchCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*AdminProjectsLocationsSubscriptionsPatchCall)UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. A maskspecifying the subscription fields to change.

typeAdminProjectsLocationsSubscriptionsSeekCalladded inv0.53.0

type AdminProjectsLocationsSubscriptionsSeekCall struct {// contains filtered or unexported fields}

func (*AdminProjectsLocationsSubscriptionsSeekCall)Contextadded inv0.53.0

Context sets the context to be used in this call's Do method.

func (*AdminProjectsLocationsSubscriptionsSeekCall)Doadded inv0.53.0

Do executes the "pubsublite.admin.projects.locations.subscriptions.seek" call.Any non-2xx status code is an error. Response headers are in either*Operation.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AdminProjectsLocationsSubscriptionsSeekCall)Fieldsadded inv0.53.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AdminProjectsLocationsSubscriptionsSeekCall)Headeradded inv0.53.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeAdminProjectsLocationsSubscriptionsService

type AdminProjectsLocationsSubscriptionsService struct {// contains filtered or unexported fields}

func (*AdminProjectsLocationsSubscriptionsService)Create

Create: Creates a new subscription.

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

func (*AdminProjectsLocationsSubscriptionsService)Delete

Delete: Deletes the specified subscription.

- name: The name of the subscription to delete.

func (*AdminProjectsLocationsSubscriptionsService)Get

Get: Returns the subscription configuration.

- name: The name of the subscription whose configuration to return.

func (*AdminProjectsLocationsSubscriptionsService)List

List: Returns the list of subscriptions for the given project.

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

func (*AdminProjectsLocationsSubscriptionsService)Patch

Patch: Updates properties of the specified subscription.

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

func (*AdminProjectsLocationsSubscriptionsService)Seekadded inv0.53.0

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

- name: The name of the subscription to seek.

typeAdminProjectsLocationsTopicsCreateCall

type AdminProjectsLocationsTopicsCreateCall struct {// contains filtered or unexported fields}

func (*AdminProjectsLocationsTopicsCreateCall)Context

Context sets the context to be used in this call's Do method.

func (*AdminProjectsLocationsTopicsCreateCall)Do

Do executes the "pubsublite.admin.projects.locations.topics.create" call.Any non-2xx status code is an error. Response headers are in either*Topic.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AdminProjectsLocationsTopicsCreateCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AdminProjectsLocationsTopicsCreateCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*AdminProjectsLocationsTopicsCreateCall)TopicId

TopicId sets the optional parameter "topicId": Required. The ID to use forthe topic, which will become the final component of the topic's name. Thisvalue is structured like: `my-topic-name`.

typeAdminProjectsLocationsTopicsDeleteCall

type AdminProjectsLocationsTopicsDeleteCall struct {// contains filtered or unexported fields}

func (*AdminProjectsLocationsTopicsDeleteCall)Context

Context sets the context to be used in this call's Do method.

func (*AdminProjectsLocationsTopicsDeleteCall)Do

Do executes the "pubsublite.admin.projects.locations.topics.delete" call.Any non-2xx status code is an error. Response headers are in either*Empty.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AdminProjectsLocationsTopicsDeleteCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AdminProjectsLocationsTopicsDeleteCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeAdminProjectsLocationsTopicsGetCall

type AdminProjectsLocationsTopicsGetCall struct {// contains filtered or unexported fields}

func (*AdminProjectsLocationsTopicsGetCall)Context

Context sets the context to be used in this call's Do method.

func (*AdminProjectsLocationsTopicsGetCall)Do

Do executes the "pubsublite.admin.projects.locations.topics.get" call.Any non-2xx status code is an error. Response headers are in either*Topic.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AdminProjectsLocationsTopicsGetCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AdminProjectsLocationsTopicsGetCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*AdminProjectsLocationsTopicsGetCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeAdminProjectsLocationsTopicsGetPartitionsCall

type AdminProjectsLocationsTopicsGetPartitionsCall struct {// contains filtered or unexported fields}

func (*AdminProjectsLocationsTopicsGetPartitionsCall)Context

Context sets the context to be used in this call's Do method.

func (*AdminProjectsLocationsTopicsGetPartitionsCall)Do

Do executes the "pubsublite.admin.projects.locations.topics.getPartitions" call.Any non-2xx status code is an error. Response headers are in either*TopicPartitions.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*AdminProjectsLocationsTopicsGetPartitionsCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AdminProjectsLocationsTopicsGetPartitionsCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*AdminProjectsLocationsTopicsGetPartitionsCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

typeAdminProjectsLocationsTopicsListCall

type AdminProjectsLocationsTopicsListCall struct {// contains filtered or unexported fields}

func (*AdminProjectsLocationsTopicsListCall)Context

Context sets the context to be used in this call's Do method.

func (*AdminProjectsLocationsTopicsListCall)Do

Do executes the "pubsublite.admin.projects.locations.topics.list" call.Any non-2xx status code is an error. Response headers are in either*ListTopicsResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*AdminProjectsLocationsTopicsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AdminProjectsLocationsTopicsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*AdminProjectsLocationsTopicsListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*AdminProjectsLocationsTopicsListCall)PageSize

PageSize sets the optional parameter "pageSize": The maximum number oftopics to return. The service may return fewer than this value. If unset orzero, all topics for the parent will be returned.

func (*AdminProjectsLocationsTopicsListCall)PageToken

PageToken sets the optional parameter "pageToken": A page token, receivedfrom a previous `ListTopics` call. Provide this to retrieve the subsequentpage. When paginating, all other parameters provided to `ListTopics` mustmatch the call that provided the page token.

func (*AdminProjectsLocationsTopicsListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeAdminProjectsLocationsTopicsPatchCall

type AdminProjectsLocationsTopicsPatchCall struct {// contains filtered or unexported fields}

func (*AdminProjectsLocationsTopicsPatchCall)Context

Context sets the context to be used in this call's Do method.

func (*AdminProjectsLocationsTopicsPatchCall)Do

Do executes the "pubsublite.admin.projects.locations.topics.patch" call.Any non-2xx status code is an error. Response headers are in either*Topic.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.

func (*AdminProjectsLocationsTopicsPatchCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AdminProjectsLocationsTopicsPatchCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*AdminProjectsLocationsTopicsPatchCall)UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. A maskspecifying the topic fields to change.

typeAdminProjectsLocationsTopicsService

type AdminProjectsLocationsTopicsService struct {Subscriptions *AdminProjectsLocationsTopicsSubscriptionsService// contains filtered or unexported fields}

func (*AdminProjectsLocationsTopicsService)Create

Create: Creates a new topic.

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

func (*AdminProjectsLocationsTopicsService)Delete

Delete: Deletes the specified topic.

- name: The name of the topic to delete.

func (*AdminProjectsLocationsTopicsService)Get

Get: Returns the topic configuration.

- name: The name of the topic whose configuration to return.

func (*AdminProjectsLocationsTopicsService)GetPartitions

GetPartitions: Returns the partition information for the requested topic.

- name: The topic whose partition information to return.

func (*AdminProjectsLocationsTopicsService)List

List: Returns the list of topics for the given project.

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

func (*AdminProjectsLocationsTopicsService)Patch

Patch: Updates properties of the specified topic.

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

typeAdminProjectsLocationsTopicsSubscriptionsListCall

type AdminProjectsLocationsTopicsSubscriptionsListCall struct {// contains filtered or unexported fields}

func (*AdminProjectsLocationsTopicsSubscriptionsListCall)Context

Context sets the context to be used in this call's Do method.

func (*AdminProjectsLocationsTopicsSubscriptionsListCall)Do

Do executes the "pubsublite.admin.projects.locations.topics.subscriptions.list" call.Any non-2xx status code is an error. Response headers are in either*ListTopicSubscriptionsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*AdminProjectsLocationsTopicsSubscriptionsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*AdminProjectsLocationsTopicsSubscriptionsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*AdminProjectsLocationsTopicsSubscriptionsListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*AdminProjectsLocationsTopicsSubscriptionsListCall)PageSize

PageSize sets the optional parameter "pageSize": The maximum number ofsubscriptions to return. The service may return fewer than this value. Ifunset or zero, all subscriptions for the given topic will be returned.

func (*AdminProjectsLocationsTopicsSubscriptionsListCall)PageToken

PageToken sets the optional parameter "pageToken": A page token, receivedfrom a previous `ListTopicSubscriptions` call. Provide this to retrieve thesubsequent page. When paginating, all other parameters provided to`ListTopicSubscriptions` must match the call that provided the page token.

func (*AdminProjectsLocationsTopicsSubscriptionsListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeAdminProjectsLocationsTopicsSubscriptionsService

type AdminProjectsLocationsTopicsSubscriptionsService struct {// contains filtered or unexported fields}

func (*AdminProjectsLocationsTopicsSubscriptionsService)List

List: Lists the subscriptions attached to the specified topic.

- name: The name of the topic whose subscriptions to list.

typeAdminProjectsService

type AdminProjectsService struct {Locations *AdminProjectsLocationsService// contains filtered or unexported fields}

funcNewAdminProjectsService

func NewAdminProjectsService(s *Service) *AdminProjectsService

typeAdminService

type AdminService struct {Projects *AdminProjectsService// contains filtered or unexported fields}

funcNewAdminService

func NewAdminService(s *Service) *AdminService

typeCancelOperationRequestadded inv0.53.0

type CancelOperationRequest struct {}

CancelOperationRequest: The request message for Operations.CancelOperation.

typeCapacity

type Capacity struct {// PublishMibPerSec: Publish throughput capacity per partition in MiB/s. Must// be >= 4 and <= 16.PublishMibPerSecint64 `json:"publishMibPerSec,omitempty"`// SubscribeMibPerSec: Subscribe throughput capacity per partition in MiB/s.// Must be >= 4 and <= 32.SubscribeMibPerSecint64 `json:"subscribeMibPerSec,omitempty"`// ForceSendFields is a list of field names (e.g. "PublishMibPerSec") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "PublishMibPerSec") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Capacity: The throughput capacity configuration for each partition.

func (Capacity)MarshalJSON

func (sCapacity) MarshalJSON() ([]byte,error)

typeCommitCursorRequestadded inv0.47.0

type CommitCursorRequest struct {// Cursor: The new value for the committed cursor.Cursor *Cursor `json:"cursor,omitempty"`// Partition: The partition for which to update the cursor. Partitions are zero// indexed, so `partition` must be in the range [0, topic.num_partitions).Partitionint64 `json:"partition,omitempty,string"`// ForceSendFields is a list of field names (e.g. "Cursor") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Cursor") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

CommitCursorRequest: Request for CommitCursor.

func (CommitCursorRequest)MarshalJSONadded inv0.47.0

func (sCommitCursorRequest) MarshalJSON() ([]byte,error)

typeCommitCursorResponseadded inv0.47.0

type CommitCursorResponse struct {// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`}

CommitCursorResponse: Response for CommitCursor.

typeComputeHeadCursorRequestadded inv0.40.0

type ComputeHeadCursorRequest struct {// Partition: Required. The partition for which we should compute the head// cursor.Partitionint64 `json:"partition,omitempty,string"`// ForceSendFields is a list of field names (e.g. "Partition") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Partition") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ComputeHeadCursorRequest: Compute the current head cursor for a partition.

func (ComputeHeadCursorRequest)MarshalJSONadded inv0.40.0

func (sComputeHeadCursorRequest) MarshalJSON() ([]byte,error)

typeComputeHeadCursorResponseadded inv0.40.0

type ComputeHeadCursorResponse struct {// HeadCursor: The head cursor.HeadCursor *Cursor `json:"headCursor,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "HeadCursor") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "HeadCursor") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ComputeHeadCursorResponse: Response containing the head cursor for therequested topic and partition.

func (ComputeHeadCursorResponse)MarshalJSONadded inv0.40.0

func (sComputeHeadCursorResponse) MarshalJSON() ([]byte,error)

typeComputeMessageStatsRequestadded inv0.33.0

type ComputeMessageStatsRequest struct {// EndCursor: The exclusive end of the range. The range is empty if end_cursor// <= start_cursor. Specifying a start_cursor before the first message and an// end_cursor after the last message will retrieve all messages.EndCursor *Cursor `json:"endCursor,omitempty"`// Partition: Required. The partition for which we should compute message// stats.Partitionint64 `json:"partition,omitempty,string"`// StartCursor: The inclusive start of the range.StartCursor *Cursor `json:"startCursor,omitempty"`// ForceSendFields is a list of field names (e.g. "EndCursor") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "EndCursor") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ComputeMessageStatsRequest: Compute statistics about a range of messages ina given topic and partition.

func (ComputeMessageStatsRequest)MarshalJSONadded inv0.33.0

func (sComputeMessageStatsRequest) MarshalJSON() ([]byte,error)

typeComputeMessageStatsResponseadded inv0.33.0

type ComputeMessageStatsResponse struct {// MessageBytes: The number of quota bytes accounted to these messages.MessageBytesint64 `json:"messageBytes,omitempty,string"`// MessageCount: The count of messages.MessageCountint64 `json:"messageCount,omitempty,string"`// MinimumEventTime: The minimum event timestamp across these messages. For the// purposes of this computation, if a message does not have an event time, we// use the publish time. The timestamp will be unset if there are no messages.MinimumEventTimestring `json:"minimumEventTime,omitempty"`// MinimumPublishTime: The minimum publish timestamp across these messages.// Note that publish timestamps within a partition are not guaranteed to be// non-decreasing. The timestamp will be unset if there are no messages.MinimumPublishTimestring `json:"minimumPublishTime,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "MessageBytes") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "MessageBytes") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ComputeMessageStatsResponse: Response containing stats for messages in therequested topic and partition.

func (ComputeMessageStatsResponse)MarshalJSONadded inv0.33.0

func (sComputeMessageStatsResponse) MarshalJSON() ([]byte,error)

typeComputeTimeCursorRequestadded inv0.47.0

type ComputeTimeCursorRequest struct {// Partition: Required. The partition for which we should compute the cursor.Partitionint64 `json:"partition,omitempty,string"`// Target: Required. The target publish or event time. Specifying a future time// will return an unset cursor.Target *TimeTarget `json:"target,omitempty"`// ForceSendFields is a list of field names (e.g. "Partition") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Partition") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ComputeTimeCursorRequest: Compute the corresponding cursor for a publish orevent time in a topic partition.

func (ComputeTimeCursorRequest)MarshalJSONadded inv0.47.0

func (sComputeTimeCursorRequest) MarshalJSON() ([]byte,error)

typeComputeTimeCursorResponseadded inv0.47.0

type ComputeTimeCursorResponse struct {// Cursor: If present, the cursor references the first message with time// greater than or equal to the specified target time. If such a message cannot// be found, the cursor will be unset (i.e. `cursor` is not present).Cursor *Cursor `json:"cursor,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Cursor") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Cursor") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ComputeTimeCursorResponse: Response containing the cursor corresponding to apublish or event time in a topic partition.

func (ComputeTimeCursorResponse)MarshalJSONadded inv0.47.0

func (sComputeTimeCursorResponse) MarshalJSON() ([]byte,error)

typeCursor

type Cursor struct {// Offset: The offset of a message within a topic partition. Must be greater// than or equal 0.Offsetint64 `json:"offset,omitempty,string"`// ForceSendFields is a list of field names (e.g. "Offset") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Offset") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Cursor: A cursor that describes the position of a message within a topicpartition.

func (Cursor)MarshalJSON

func (sCursor) MarshalJSON() ([]byte,error)

typeCursorProjectsLocationsService

type CursorProjectsLocationsService struct {Subscriptions *CursorProjectsLocationsSubscriptionsService// contains filtered or unexported fields}

funcNewCursorProjectsLocationsService

func NewCursorProjectsLocationsService(s *Service) *CursorProjectsLocationsService

typeCursorProjectsLocationsSubscriptionsCommitCursorCalladded inv0.47.0

type CursorProjectsLocationsSubscriptionsCommitCursorCall struct {// contains filtered or unexported fields}

func (*CursorProjectsLocationsSubscriptionsCommitCursorCall)Contextadded inv0.47.0

Context sets the context to be used in this call's Do method.

func (*CursorProjectsLocationsSubscriptionsCommitCursorCall)Doadded inv0.47.0

Do executes the "pubsublite.cursor.projects.locations.subscriptions.commitCursor" call.Any non-2xx status code is an error. Response headers are in either*CommitCursorResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.

func (*CursorProjectsLocationsSubscriptionsCommitCursorCall)Fieldsadded inv0.47.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CursorProjectsLocationsSubscriptionsCommitCursorCall)Headeradded inv0.47.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeCursorProjectsLocationsSubscriptionsCursorsListCall

type CursorProjectsLocationsSubscriptionsCursorsListCall struct {// contains filtered or unexported fields}

func (*CursorProjectsLocationsSubscriptionsCursorsListCall)Context

Context sets the context to be used in this call's Do method.

func (*CursorProjectsLocationsSubscriptionsCursorsListCall)Do

Do executes the "pubsublite.cursor.projects.locations.subscriptions.cursors.list" call.Any non-2xx status code is an error. Response headers are in either*ListPartitionCursorsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*CursorProjectsLocationsSubscriptionsCursorsListCall)Fields

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*CursorProjectsLocationsSubscriptionsCursorsListCall)Header

Header returns a http.Header that can be modified by the caller to addheaders to the request.

func (*CursorProjectsLocationsSubscriptionsCursorsListCall)IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.

func (*CursorProjectsLocationsSubscriptionsCursorsListCall)PageSize

PageSize sets the optional parameter "pageSize": The maximum number ofcursors to return. The service may return fewer than this value. If unset orzero, all cursors for the parent will be returned.

func (*CursorProjectsLocationsSubscriptionsCursorsListCall)PageToken

PageToken sets the optional parameter "pageToken": A page token, receivedfrom a previous `ListPartitionCursors` call. Provide this to retrieve thesubsequent page. When paginating, all other parameters provided to`ListPartitionCursors` must match the call that provided the page token.

func (*CursorProjectsLocationsSubscriptionsCursorsListCall)Pages

Pages invokes f for each page of results.A non-nil error returned from f will halt the iteration.The provided context supersedes any context provided to the Context method.

typeCursorProjectsLocationsSubscriptionsCursorsService

type CursorProjectsLocationsSubscriptionsCursorsService struct {// contains filtered or unexported fields}

func (*CursorProjectsLocationsSubscriptionsCursorsService)List

List: Returns all committed cursor information for a subscription.

  • parent: The subscription for which to retrieve cursors. Structured like`projects/{project_number}/locations/{location}/subscriptions/{subscription_id}`.

typeCursorProjectsLocationsSubscriptionsService

type CursorProjectsLocationsSubscriptionsService struct {Cursors *CursorProjectsLocationsSubscriptionsCursorsService// contains filtered or unexported fields}

func (*CursorProjectsLocationsSubscriptionsService)CommitCursoradded inv0.47.0

CommitCursor: Updates the committed cursor.

- subscription: The subscription for which to update the cursor.

typeCursorProjectsService

type CursorProjectsService struct {Locations *CursorProjectsLocationsService// contains filtered or unexported fields}

funcNewCursorProjectsService

func NewCursorProjectsService(s *Service) *CursorProjectsService

typeCursorService

type CursorService struct {Projects *CursorProjectsService// contains filtered or unexported fields}

funcNewCursorService

func NewCursorService(s *Service) *CursorService

typeDeliveryConfig

type DeliveryConfig struct {// DeliveryRequirement: The DeliveryRequirement for this subscription.//// Possible values://   "DELIVERY_REQUIREMENT_UNSPECIFIED" - Default value. This value is unused.//   "DELIVER_IMMEDIATELY" - The server does not wait for a published message// to be successfully written to storage before delivering it to subscribers.//   "DELIVER_AFTER_STORED" - The server will not deliver a published message// to subscribers until the message has been successfully written to storage.// This will result in higher end-to-end latency, but consistent delivery.DeliveryRequirementstring `json:"deliveryRequirement,omitempty"`// ForceSendFields is a list of field names (e.g. "DeliveryRequirement") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DeliveryRequirement") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

DeliveryConfig: The settings for a subscription's message delivery.

func (DeliveryConfig)MarshalJSON

func (sDeliveryConfig) MarshalJSON() ([]byte,error)

typeEmpty

type Empty struct {// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`}

Empty: A generic empty message that you can re-use to avoid definingduplicated empty messages in your APIs. A typical example is to use it asthe request or the response type of an API method. For instance: service Foo{ rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

typeExportConfigadded inv0.106.0

type ExportConfig struct {// CurrentState: Output only. The current state of the export, which may be// different to the desired state due to errors. This field is output only.//// Possible values://   "STATE_UNSPECIFIED" - Default value. This value is unused.//   "ACTIVE" - Messages are being exported.//   "PAUSED" - Exporting messages is suspended.//   "PERMISSION_DENIED" - Messages cannot be exported due to permission denied// errors. Output only.//   "NOT_FOUND" - Messages cannot be exported due to missing resources. Output// only.CurrentStatestring `json:"currentState,omitempty"`// DeadLetterTopic: Optional. The name of an optional Pub/Sub Lite topic to// publish messages that can not be exported to the destination. For example,// the message can not be published to the Pub/Sub service because it does not// satisfy the constraints documented at//https://cloud.google.com/pubsub/docs/publisher. Structured like:// projects/{project_number}/locations/{location}/topics/{topic_id}. Must be// within the same project and location as the subscription. The topic may be// changed or removed.DeadLetterTopicstring `json:"deadLetterTopic,omitempty"`// DesiredState: The desired state of this export. Setting this to values other// than `ACTIVE` and `PAUSED` will result in an error.//// Possible values://   "STATE_UNSPECIFIED" - Default value. This value is unused.//   "ACTIVE" - Messages are being exported.//   "PAUSED" - Exporting messages is suspended.//   "PERMISSION_DENIED" - Messages cannot be exported due to permission denied// errors. Output only.//   "NOT_FOUND" - Messages cannot be exported due to missing resources. Output// only.DesiredStatestring `json:"desiredState,omitempty"`// PubsubConfig: Messages are automatically written from the Pub/Sub Lite topic// associated with this subscription to a Pub/Sub topic.PubsubConfig *PubSubConfig `json:"pubsubConfig,omitempty"`// ForceSendFields is a list of field names (e.g. "CurrentState") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CurrentState") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ExportConfig: Configuration for a Pub/Sub Lite subscription that writesmessages to a destination. User subscriber clients must not connect to thissubscription.

func (ExportConfig)MarshalJSONadded inv0.106.0

func (sExportConfig) MarshalJSON() ([]byte,error)

typeListOperationsResponseadded inv0.53.0

type ListOperationsResponse struct {// NextPageToken: The standard List next-page token.NextPageTokenstring `json:"nextPageToken,omitempty"`// Operations: A list of operations that matches the specified filter in the// request.Operations []*Operation `json:"operations,omitempty"`// Unreachable: Unordered list. Unreachable resources. Populated when the// request sets `ListOperationsRequest.return_partial_success` and reads across// collections. For example, when attempting to list all resources across all// supported locations.Unreachable []string `json:"unreachable,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListOperationsResponse: The response message for Operations.ListOperations.

func (ListOperationsResponse)MarshalJSONadded inv0.53.0

func (sListOperationsResponse) MarshalJSON() ([]byte,error)

typeListPartitionCursorsResponse

type ListPartitionCursorsResponse struct {// NextPageToken: A token, which can be sent as `page_token` to retrieve the// next page. If this field is omitted, there are no subsequent pages.NextPageTokenstring `json:"nextPageToken,omitempty"`// PartitionCursors: The partition cursors from this request.PartitionCursors []*PartitionCursor `json:"partitionCursors,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListPartitionCursorsResponse: Response for ListPartitionCursors

func (ListPartitionCursorsResponse)MarshalJSON

func (sListPartitionCursorsResponse) MarshalJSON() ([]byte,error)

typeListReservationTopicsResponseadded inv0.57.0

type ListReservationTopicsResponse struct {// NextPageToken: A token that can be sent as `page_token` to retrieve the next// page of results. If this field is omitted, there are no more results.NextPageTokenstring `json:"nextPageToken,omitempty"`// Topics: The names of topics attached to the reservation. The order of the// topics is unspecified.Topics []string `json:"topics,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListReservationTopicsResponse: Response for ListReservationTopics.

func (ListReservationTopicsResponse)MarshalJSONadded inv0.57.0

func (sListReservationTopicsResponse) MarshalJSON() ([]byte,error)

typeListReservationsResponseadded inv0.57.0

type ListReservationsResponse struct {// NextPageToken: A token that can be sent as `page_token` to retrieve the next// page of results. If this field is omitted, there are no more results.NextPageTokenstring `json:"nextPageToken,omitempty"`// Reservations: The list of reservation in the requested parent. The order of// the reservations is unspecified.Reservations []*Reservation `json:"reservations,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListReservationsResponse: Response for ListReservations.

func (ListReservationsResponse)MarshalJSONadded inv0.57.0

func (sListReservationsResponse) MarshalJSON() ([]byte,error)

typeListSubscriptionsResponse

type ListSubscriptionsResponse struct {// NextPageToken: A token that can be sent as `page_token` to retrieve the next// page of results. If this field is omitted, there are no more results.NextPageTokenstring `json:"nextPageToken,omitempty"`// Subscriptions: The list of subscriptions in the requested parent. The order// of the subscriptions is unspecified.Subscriptions []*Subscription `json:"subscriptions,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListSubscriptionsResponse: Response for ListSubscriptions.

func (ListSubscriptionsResponse)MarshalJSON

func (sListSubscriptionsResponse) MarshalJSON() ([]byte,error)

typeListTopicSubscriptionsResponse

type ListTopicSubscriptionsResponse struct {// NextPageToken: A token that can be sent as `page_token` to retrieve the next// page of results. If this field is omitted, there are no more results.NextPageTokenstring `json:"nextPageToken,omitempty"`// Subscriptions: The names of subscriptions attached to the topic. The order// of the subscriptions is unspecified.Subscriptions []string `json:"subscriptions,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListTopicSubscriptionsResponse: Response for ListTopicSubscriptions.

func (ListTopicSubscriptionsResponse)MarshalJSON

func (sListTopicSubscriptionsResponse) MarshalJSON() ([]byte,error)

typeListTopicsResponse

type ListTopicsResponse struct {// NextPageToken: A token that can be sent as `page_token` to retrieve the next// page of results. If this field is omitted, there are no more results.NextPageTokenstring `json:"nextPageToken,omitempty"`// Topics: The list of topic in the requested parent. The order of the topics// is unspecified.Topics []*Topic `json:"topics,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "NextPageToken") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NextPageToken") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ListTopicsResponse: Response for ListTopics.

func (ListTopicsResponse)MarshalJSON

func (sListTopicsResponse) MarshalJSON() ([]byte,error)

typeOperationadded inv0.53.0

type Operation struct {// Done: If the value is `false`, it means the operation is still in progress.// If `true`, the operation is completed, and either `error` or `response` is// available.Donebool `json:"done,omitempty"`// Error: The error result of the operation in case of failure or cancellation.Error *Status `json:"error,omitempty"`// Metadata: Service-specific metadata associated with the operation. It// typically contains progress information and common metadata such as create// time. Some services might not provide such metadata. Any method that returns// a long-running operation should document the metadata type, if any.Metadatagoogleapi.RawMessage `json:"metadata,omitempty"`// Name: The server-assigned name, which is only unique within the same service// that originally returns it. If you use the default HTTP mapping, the `name`// should be a resource name ending with `operations/{unique_id}`.Namestring `json:"name,omitempty"`// Response: The normal, successful response of the operation. If the original// method returns no data on success, such as `Delete`, the response is// `google.protobuf.Empty`. If the original method is standard// `Get`/`Create`/`Update`, the response should be the resource. For other// methods, the response should have the type `XxxResponse`, where `Xxx` is the// original method name. For example, if the original method name is// `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.Responsegoogleapi.RawMessage `json:"response,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Done") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Done") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Operation: This resource represents a long-running operation that is theresult of a network API call.

func (Operation)MarshalJSONadded inv0.53.0

func (sOperation) MarshalJSON() ([]byte,error)

typeOperationMetadataadded inv0.53.0

type OperationMetadata struct {// CreateTime: The time the operation was created.CreateTimestring `json:"createTime,omitempty"`// EndTime: The time the operation finished running. Not set if the operation// has not completed.EndTimestring `json:"endTime,omitempty"`// Target: Resource path for the target of the operation. For example, targets// of seeks are subscription resources, structured like:// projects/{project_number}/locations/{location}/subscriptions/{subscription_id// }Targetstring `json:"target,omitempty"`// Verb: Name of the verb executed by the operation.Verbstring `json:"verb,omitempty"`// ForceSendFields is a list of field names (e.g. "CreateTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CreateTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

OperationMetadata: Metadata for long running operations.

func (OperationMetadata)MarshalJSONadded inv0.53.0

func (sOperationMetadata) MarshalJSON() ([]byte,error)

typePartitionConfig

type PartitionConfig struct {// Capacity: The capacity configuration.Capacity *Capacity `json:"capacity,omitempty"`// Count: The number of partitions in the topic. Must be at least 1. Once a// topic has been created the number of partitions can be increased but not// decreased. Message ordering is not guaranteed across a topic resize. For// more information see//https://cloud.google.com/pubsub/lite/docs/topics#scaling_capacityCountint64 `json:"count,omitempty,string"`// Scale: DEPRECATED: Use capacity instead which can express a superset of// configurations. Every partition in the topic is allocated throughput// equivalent to `scale` times the standard partition throughput (4 MiB/s).// This is also reflected in the cost of this topic; a topic with `scale` of 2// and count of 10 is charged for 20 partitions. This value must be in the// range [1,4].Scaleint64 `json:"scale,omitempty"`// ForceSendFields is a list of field names (e.g. "Capacity") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Capacity") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

PartitionConfig: The settings for a topic's partitions.

func (PartitionConfig)MarshalJSON

func (sPartitionConfig) MarshalJSON() ([]byte,error)

typePartitionCursor

type PartitionCursor struct {// Cursor: The value of the cursor.Cursor *Cursor `json:"cursor,omitempty"`// Partition: The partition this is for.Partitionint64 `json:"partition,omitempty,string"`// ForceSendFields is a list of field names (e.g. "Cursor") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Cursor") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

PartitionCursor: A pair of a Cursor and the partition it is for.

func (PartitionCursor)MarshalJSON

func (sPartitionCursor) MarshalJSON() ([]byte,error)

typePubSubConfigadded inv0.106.0

type PubSubConfig struct {// Topic: The name of the Pub/Sub topic. Structured like:// projects/{project_number}/topics/{topic_id}. The topic may be changed.Topicstring `json:"topic,omitempty"`// ForceSendFields is a list of field names (e.g. "Topic") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Topic") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

PubSubConfig: Configuration for exporting to a Pub/Sub topic.

func (PubSubConfig)MarshalJSONadded inv0.106.0

func (sPubSubConfig) MarshalJSON() ([]byte,error)

typeReservationadded inv0.57.0

type Reservation struct {// Name: The name of the reservation. Structured like:// projects/{project_number}/locations/{location}/reservations/{reservation_id}Namestring `json:"name,omitempty"`// ThroughputCapacity: The reserved throughput capacity. Every unit of// throughput capacity is equivalent to 1 MiB/s of published messages or 2// MiB/s of subscribed messages. Any topics which are declared as using// capacity from a Reservation will consume resources from this reservation// instead of being charged individually.ThroughputCapacityint64 `json:"throughputCapacity,omitempty,string"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Name") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Name") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Reservation: Metadata about a reservation resource.

func (Reservation)MarshalJSONadded inv0.57.0

func (sReservation) MarshalJSON() ([]byte,error)

typeReservationConfigadded inv0.57.0

type ReservationConfig struct {// ThroughputReservation: The Reservation to use for this topic's throughput// capacity. Structured like:// projects/{project_number}/locations/{location}/reservations/{reservation_id}ThroughputReservationstring `json:"throughputReservation,omitempty"`// ForceSendFields is a list of field names (e.g. "ThroughputReservation") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "ThroughputReservation") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

ReservationConfig: The settings for this topic's Reservation usage.

func (ReservationConfig)MarshalJSONadded inv0.57.0

func (sReservationConfig) MarshalJSON() ([]byte,error)

typeRetentionConfig

type RetentionConfig struct {// PerPartitionBytes: The provisioned storage, in bytes, per partition. If the// number of bytes stored in any of the topic's partitions grows beyond this// value, older messages will be dropped to make room for newer ones,// regardless of the value of `period`.PerPartitionBytesint64 `json:"perPartitionBytes,omitempty,string"`// Period: How long a published message is retained. If unset, messages will be// retained as long as the bytes retained for each partition is below// `per_partition_bytes`.Periodstring `json:"period,omitempty"`// ForceSendFields is a list of field names (e.g. "PerPartitionBytes") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "PerPartitionBytes") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

RetentionConfig: The settings for a topic's message retention.

func (RetentionConfig)MarshalJSON

func (sRetentionConfig) MarshalJSON() ([]byte,error)

typeSeekSubscriptionRequestadded inv0.53.0

type SeekSubscriptionRequest struct {// NamedTarget: Seek to a named position with respect to the message backlog.//// Possible values://   "NAMED_TARGET_UNSPECIFIED" - Unspecified named target. Do not use.//   "TAIL" - Seek to the oldest retained message.//   "HEAD" - Seek past all recently published messages, skipping the entire// message backlog.NamedTargetstring `json:"namedTarget,omitempty"`// TimeTarget: Seek to the first message whose publish or event time is greater// than or equal to the specified query time. If no such message can be// located, will seek to the end of the message backlog.TimeTarget *TimeTarget `json:"timeTarget,omitempty"`// ForceSendFields is a list of field names (e.g. "NamedTarget") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "NamedTarget") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

SeekSubscriptionRequest: Request for SeekSubscription.

func (SeekSubscriptionRequest)MarshalJSONadded inv0.53.0

func (sSeekSubscriptionRequest) MarshalJSON() ([]byte,error)

typeSeekSubscriptionResponseadded inv0.53.0

type SeekSubscriptionResponse struct {}

SeekSubscriptionResponse: Response for SeekSubscription long runningoperation.

typeService

type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentAdmin *AdminServiceCursor *CursorServiceTopicStats *TopicStatsService// contains filtered or unexported fields}

funcNewdeprecated

func New(client *http.Client) (*Service,error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead.To provide a custom HTTP client, use option.WithHTTPClient.If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

funcNewService

func NewService(ctxcontext.Context, opts ...option.ClientOption) (*Service,error)

NewService creates a new Service.

typeStatusadded inv0.53.0

type Status struct {// Code: The status code, which should be an enum value of google.rpc.Code.Codeint64 `json:"code,omitempty"`// Details: A list of messages that carry the error details. There is a common// set of message types for APIs to use.Details []googleapi.RawMessage `json:"details,omitempty"`// Message: A developer-facing error message, which should be in English. Any// user-facing error message should be localized and sent in the// google.rpc.Status.details field, or localized by the client.Messagestring `json:"message,omitempty"`// ForceSendFields is a list of field names (e.g. "Code") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Code") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Status: The `Status` type defines a logical error model that is suitable fordifferent programming environments, including REST APIs and RPC APIs. It isused by gRPC (https://github.com/grpc). Each `Status` message contains threepieces of data: error code, error message, and error details. You can findout more about this error model and how to work with it in the API DesignGuide (https://cloud.google.com/apis/design/errors).

func (Status)MarshalJSONadded inv0.53.0

func (sStatus) MarshalJSON() ([]byte,error)

typeSubscription

type Subscription struct {// DeliveryConfig: The settings for this subscription's message delivery.DeliveryConfig *DeliveryConfig `json:"deliveryConfig,omitempty"`// ExportConfig: If present, messages are automatically written from the// Pub/Sub Lite topic associated with this subscription to a destination.ExportConfig *ExportConfig `json:"exportConfig,omitempty"`// Name: The name of the subscription. Structured like:// projects/{project_number}/locations/{location}/subscriptions/{subscription_id// }Namestring `json:"name,omitempty"`// Topic: The name of the topic this subscription is attached to. Structured// like: projects/{project_number}/locations/{location}/topics/{topic_id}Topicstring `json:"topic,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "DeliveryConfig") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DeliveryConfig") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Subscription: Metadata about a subscription resource.

func (Subscription)MarshalJSON

func (sSubscription) MarshalJSON() ([]byte,error)

typeTimeTargetadded inv0.47.0

type TimeTarget struct {// EventTime: Request the cursor of the first message with event time greater// than or equal to `event_time`. If messages are missing an event time, the// publish time is used as a fallback. As event times are user supplied,// subsequent messages may have event times less than `event_time` and should// be filtered by the client, if necessary.EventTimestring `json:"eventTime,omitempty"`// PublishTime: Request the cursor of the first message with publish time// greater than or equal to `publish_time`. All messages thereafter are// guaranteed to have publish times >= `publish_time`.PublishTimestring `json:"publishTime,omitempty"`// ForceSendFields is a list of field names (e.g. "EventTime") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "EventTime") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

TimeTarget: A target publish or event time. Can be used for seeking to orretrieving the corresponding cursor.

func (TimeTarget)MarshalJSONadded inv0.47.0

func (sTimeTarget) MarshalJSON() ([]byte,error)

typeTopic

type Topic struct {// Name: The name of the topic. Structured like:// projects/{project_number}/locations/{location}/topics/{topic_id}Namestring `json:"name,omitempty"`// PartitionConfig: The settings for this topic's partitions.PartitionConfig *PartitionConfig `json:"partitionConfig,omitempty"`// ReservationConfig: The settings for this topic's Reservation usage.ReservationConfig *ReservationConfig `json:"reservationConfig,omitempty"`// RetentionConfig: The settings for this topic's message retention.RetentionConfig *RetentionConfig `json:"retentionConfig,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "Name") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Name") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

Topic: Metadata about a topic resource.

func (Topic)MarshalJSON

func (sTopic) MarshalJSON() ([]byte,error)

typeTopicPartitions

type TopicPartitions struct {// PartitionCount: The number of partitions in the topic.PartitionCountint64 `json:"partitionCount,omitempty,string"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "PartitionCount") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "PartitionCount") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}

TopicPartitions: Response for GetTopicPartitions.

func (TopicPartitions)MarshalJSON

func (sTopicPartitions) MarshalJSON() ([]byte,error)

typeTopicStatsProjectsLocationsServiceadded inv0.33.0

type TopicStatsProjectsLocationsService struct {Topics *TopicStatsProjectsLocationsTopicsService// contains filtered or unexported fields}

funcNewTopicStatsProjectsLocationsServiceadded inv0.33.0

func NewTopicStatsProjectsLocationsService(s *Service) *TopicStatsProjectsLocationsService

typeTopicStatsProjectsLocationsTopicsComputeHeadCursorCalladded inv0.40.0

type TopicStatsProjectsLocationsTopicsComputeHeadCursorCall struct {// contains filtered or unexported fields}

func (*TopicStatsProjectsLocationsTopicsComputeHeadCursorCall)Contextadded inv0.40.0

Context sets the context to be used in this call's Do method.

func (*TopicStatsProjectsLocationsTopicsComputeHeadCursorCall)Doadded inv0.40.0

Do executes the "pubsublite.topicStats.projects.locations.topics.computeHeadCursor" call.Any non-2xx status code is an error. Response headers are in either*ComputeHeadCursorResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*TopicStatsProjectsLocationsTopicsComputeHeadCursorCall)Fieldsadded inv0.40.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*TopicStatsProjectsLocationsTopicsComputeHeadCursorCall)Headeradded inv0.40.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeTopicStatsProjectsLocationsTopicsComputeMessageStatsCalladded inv0.33.0

type TopicStatsProjectsLocationsTopicsComputeMessageStatsCall struct {// contains filtered or unexported fields}

func (*TopicStatsProjectsLocationsTopicsComputeMessageStatsCall)Contextadded inv0.33.0

Context sets the context to be used in this call's Do method.

func (*TopicStatsProjectsLocationsTopicsComputeMessageStatsCall)Doadded inv0.33.0

Do executes the "pubsublite.topicStats.projects.locations.topics.computeMessageStats" call.Any non-2xx status code is an error. Response headers are in either*ComputeMessageStatsResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*TopicStatsProjectsLocationsTopicsComputeMessageStatsCall)Fieldsadded inv0.33.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*TopicStatsProjectsLocationsTopicsComputeMessageStatsCall)Headeradded inv0.33.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeTopicStatsProjectsLocationsTopicsComputeTimeCursorCalladded inv0.47.0

type TopicStatsProjectsLocationsTopicsComputeTimeCursorCall struct {// contains filtered or unexported fields}

func (*TopicStatsProjectsLocationsTopicsComputeTimeCursorCall)Contextadded inv0.47.0

Context sets the context to be used in this call's Do method.

func (*TopicStatsProjectsLocationsTopicsComputeTimeCursorCall)Doadded inv0.47.0

Do executes the "pubsublite.topicStats.projects.locations.topics.computeTimeCursor" call.Any non-2xx status code is an error. Response headers are in either*ComputeTimeCursorResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.

func (*TopicStatsProjectsLocationsTopicsComputeTimeCursorCall)Fieldsadded inv0.47.0

Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.

func (*TopicStatsProjectsLocationsTopicsComputeTimeCursorCall)Headeradded inv0.47.0

Header returns a http.Header that can be modified by the caller to addheaders to the request.

typeTopicStatsProjectsLocationsTopicsServiceadded inv0.33.0

type TopicStatsProjectsLocationsTopicsService struct {// contains filtered or unexported fields}

funcNewTopicStatsProjectsLocationsTopicsServiceadded inv0.33.0

func NewTopicStatsProjectsLocationsTopicsService(s *Service) *TopicStatsProjectsLocationsTopicsService

func (*TopicStatsProjectsLocationsTopicsService)ComputeHeadCursoradded inv0.40.0

ComputeHeadCursor: Compute the head cursor for the partition. The headcursor's offset is guaranteed to be less than or equal to all messages whichhave not yet been acknowledged as published, and greater than the offset ofany message whose publish has already been acknowledged. It is zero if therehave never been messages in the partition.

- topic: The topic for which we should compute the head cursor.

func (*TopicStatsProjectsLocationsTopicsService)ComputeMessageStatsadded inv0.33.0

ComputeMessageStats: Compute statistics about a range of messages in a giventopic and partition.

- topic: The topic for which we should compute message stats.

func (*TopicStatsProjectsLocationsTopicsService)ComputeTimeCursoradded inv0.47.0

ComputeTimeCursor: Compute the corresponding cursor for a publish or eventtime in a topic partition.

- topic: The topic for which we should compute the cursor.

typeTopicStatsProjectsServiceadded inv0.33.0

type TopicStatsProjectsService struct {Locations *TopicStatsProjectsLocationsService// contains filtered or unexported fields}

funcNewTopicStatsProjectsServiceadded inv0.33.0

func NewTopicStatsProjectsService(s *Service) *TopicStatsProjectsService

typeTopicStatsServiceadded inv0.33.0

type TopicStatsService struct {Projects *TopicStatsProjectsService// contains filtered or unexported fields}

funcNewTopicStatsServiceadded inv0.33.0

func NewTopicStatsService(s *Service) *TopicStatsService

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f orF : Jump to
y orY : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic.Learn more.

[8]ページ先頭

©2009-2025 Movatter.jp