pubsublite

package
v0.114.0 Latest Latest
Warning

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

 Go to latest Published: Mar 17, 2023 License: BSD-3-Clause Imports: 16 Imported by: 0

Documentation

Overview

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

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

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 for authentication.

For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use 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 OAuth flow), use option.WithTokenSource: 

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

See https://godoc.org/google.golang.org/api/option/ 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

type AdminProjectsLocationsOperationsCancelCall added in v0.53.0 

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

func (*AdminProjectsLocationsOperationsCancelCall) Context added in v0.53.0 

func (c *AdminProjectsLocationsOperationsCancelCall) Context(ctx context.Context) *AdminProjectsLocationsOperationsCancelCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AdminProjectsLocationsOperationsCancelCall) Do added in v0.53.0 

func (c *AdminProjectsLocationsOperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, error)

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

func (*AdminProjectsLocationsOperationsCancelCall) Fields added in v0.53.0 

func (c *AdminProjectsLocationsOperationsCancelCall) Fields(s ...googleapi.Field) *AdminProjectsLocationsOperationsCancelCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AdminProjectsLocationsOperationsCancelCall) Header added in v0.53.0 

func (c *AdminProjectsLocationsOperationsCancelCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type AdminProjectsLocationsOperationsDeleteCall added in v0.53.0 

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

func (*AdminProjectsLocationsOperationsDeleteCall) Context added in v0.53.0 

func (c *AdminProjectsLocationsOperationsDeleteCall) Context(ctx context.Context) *AdminProjectsLocationsOperationsDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AdminProjectsLocationsOperationsDeleteCall) Do added in v0.53.0 

func (c *AdminProjectsLocationsOperationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

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

func (*AdminProjectsLocationsOperationsDeleteCall) Fields added in v0.53.0 

func (c *AdminProjectsLocationsOperationsDeleteCall) Fields(s ...googleapi.Field) *AdminProjectsLocationsOperationsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AdminProjectsLocationsOperationsDeleteCall) Header added in v0.53.0 

func (c *AdminProjectsLocationsOperationsDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type AdminProjectsLocationsOperationsGetCall added in v0.53.0 

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

func (*AdminProjectsLocationsOperationsGetCall) Context added in v0.53.0 

func (c *AdminProjectsLocationsOperationsGetCall) Context(ctx context.Context) *AdminProjectsLocationsOperationsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AdminProjectsLocationsOperationsGetCall) Do added in v0.53.0 

func (c *AdminProjectsLocationsOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)

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

func (*AdminProjectsLocationsOperationsGetCall) Fields added in v0.53.0 

func (c *AdminProjectsLocationsOperationsGetCall) Fields(s ...googleapi.Field) *AdminProjectsLocationsOperationsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AdminProjectsLocationsOperationsGetCall) Header added in v0.53.0 

func (c *AdminProjectsLocationsOperationsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AdminProjectsLocationsOperationsGetCall) IfNoneMatch added in v0.53.0 

func (c *AdminProjectsLocationsOperationsGetCall) IfNoneMatch(entityTag string) *AdminProjectsLocationsOperationsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type AdminProjectsLocationsOperationsListCall added in v0.53.0 

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

func (*AdminProjectsLocationsOperationsListCall) Context added in v0.53.0 

func (c *AdminProjectsLocationsOperationsListCall) Context(ctx context.Context) *AdminProjectsLocationsOperationsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AdminProjectsLocationsOperationsListCall) Do added in v0.53.0 

func (c *AdminProjectsLocationsOperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)

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

func (*AdminProjectsLocationsOperationsListCall) Fields added in v0.53.0 

func (c *AdminProjectsLocationsOperationsListCall) Fields(s ...googleapi.Field) *AdminProjectsLocationsOperationsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AdminProjectsLocationsOperationsListCall) Filter added in v0.53.0 

func (c *AdminProjectsLocationsOperationsListCall) Filter(filter string) *AdminProjectsLocationsOperationsListCall

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

func (*AdminProjectsLocationsOperationsListCall) Header added in v0.53.0 

func (c *AdminProjectsLocationsOperationsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AdminProjectsLocationsOperationsListCall) IfNoneMatch added in v0.53.0 

func (c *AdminProjectsLocationsOperationsListCall) IfNoneMatch(entityTag string) *AdminProjectsLocationsOperationsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*AdminProjectsLocationsOperationsListCall) PageSize added in v0.53.0 

func (c *AdminProjectsLocationsOperationsListCall) PageSize(pageSize int64) *AdminProjectsLocationsOperationsListCall

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

func (*AdminProjectsLocationsOperationsListCall) PageToken added in v0.53.0 

func (c *AdminProjectsLocationsOperationsListCall) PageToken(pageToken string) *AdminProjectsLocationsOperationsListCall

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

func (*AdminProjectsLocationsOperationsListCall) Pages added in v0.53.0 

func (c *AdminProjectsLocationsOperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error

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.

type AdminProjectsLocationsOperationsService added in v0.53.0 

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

func NewAdminProjectsLocationsOperationsService added in v0.53.0 

func NewAdminProjectsLocationsOperationsService(s *Service) *AdminProjectsLocationsOperationsService

func (*AdminProjectsLocationsOperationsService) Cancel added in v0.53.0 

func (r *AdminProjectsLocationsOperationsService) Cancel(name string, canceloperationrequest *CancelOperationRequest) *AdminProjectsLocationsOperationsCancelCall

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

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

func (*AdminProjectsLocationsOperationsService) Delete added in v0.53.0 

func (r *AdminProjectsLocationsOperationsService) Delete(name string) *AdminProjectsLocationsOperationsDeleteCall

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

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

func (*AdminProjectsLocationsOperationsService) Get added in v0.53.0 

func (r *AdminProjectsLocationsOperationsService) Get(name string) *AdminProjectsLocationsOperationsGetCall

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

- name: The name of the operation resource.

func (*AdminProjectsLocationsOperationsService) List added in v0.53.0 

func (r *AdminProjectsLocationsOperationsService) List(name string) *AdminProjectsLocationsOperationsListCall

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

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

type AdminProjectsLocationsReservationsCreateCall added in v0.57.0 

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

func (*AdminProjectsLocationsReservationsCreateCall) Context added in v0.57.0 

func (c *AdminProjectsLocationsReservationsCreateCall) Context(ctx context.Context) *AdminProjectsLocationsReservationsCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AdminProjectsLocationsReservationsCreateCall) Do added in v0.57.0 

func (c *AdminProjectsLocationsReservationsCreateCall) Do(opts ...googleapi.CallOption) (*Reservation, error)

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

func (*AdminProjectsLocationsReservationsCreateCall) Fields added in v0.57.0 

func (c *AdminProjectsLocationsReservationsCreateCall) Fields(s ...googleapi.Field) *AdminProjectsLocationsReservationsCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AdminProjectsLocationsReservationsCreateCall) Header added in v0.57.0 

func (c *AdminProjectsLocationsReservationsCreateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AdminProjectsLocationsReservationsCreateCall) ReservationId added in v0.57.0 

func (c *AdminProjectsLocationsReservationsCreateCall) ReservationId(reservationId string) *AdminProjectsLocationsReservationsCreateCall

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

type AdminProjectsLocationsReservationsDeleteCall added in v0.57.0 

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

func (*AdminProjectsLocationsReservationsDeleteCall) Context added in v0.57.0 

func (c *AdminProjectsLocationsReservationsDeleteCall) Context(ctx context.Context) *AdminProjectsLocationsReservationsDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AdminProjectsLocationsReservationsDeleteCall) Do added in v0.57.0 

func (c *AdminProjectsLocationsReservationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

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

func (*AdminProjectsLocationsReservationsDeleteCall) Fields added in v0.57.0 

func (c *AdminProjectsLocationsReservationsDeleteCall) Fields(s ...googleapi.Field) *AdminProjectsLocationsReservationsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AdminProjectsLocationsReservationsDeleteCall) Header added in v0.57.0 

func (c *AdminProjectsLocationsReservationsDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type AdminProjectsLocationsReservationsGetCall added in v0.57.0 

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

func (*AdminProjectsLocationsReservationsGetCall) Context added in v0.57.0 

func (c *AdminProjectsLocationsReservationsGetCall) Context(ctx context.Context) *AdminProjectsLocationsReservationsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AdminProjectsLocationsReservationsGetCall) Do added in v0.57.0 

func (c *AdminProjectsLocationsReservationsGetCall) Do(opts ...googleapi.CallOption) (*Reservation, error)

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

func (*AdminProjectsLocationsReservationsGetCall) Fields added in v0.57.0 

func (c *AdminProjectsLocationsReservationsGetCall) Fields(s ...googleapi.Field) *AdminProjectsLocationsReservationsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AdminProjectsLocationsReservationsGetCall) Header added in v0.57.0 

func (c *AdminProjectsLocationsReservationsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AdminProjectsLocationsReservationsGetCall) IfNoneMatch added in v0.57.0 

func (c *AdminProjectsLocationsReservationsGetCall) IfNoneMatch(entityTag string) *AdminProjectsLocationsReservationsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type AdminProjectsLocationsReservationsListCall added in v0.57.0 

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

func (*AdminProjectsLocationsReservationsListCall) Context added in v0.57.0 

func (c *AdminProjectsLocationsReservationsListCall) Context(ctx context.Context) *AdminProjectsLocationsReservationsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AdminProjectsLocationsReservationsListCall) Do added in v0.57.0 

func (c *AdminProjectsLocationsReservationsListCall) Do(opts ...googleapi.CallOption) (*ListReservationsResponse, error)

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

func (*AdminProjectsLocationsReservationsListCall) Fields added in v0.57.0 

func (c *AdminProjectsLocationsReservationsListCall) Fields(s ...googleapi.Field) *AdminProjectsLocationsReservationsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AdminProjectsLocationsReservationsListCall) Header added in v0.57.0 

func (c *AdminProjectsLocationsReservationsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AdminProjectsLocationsReservationsListCall) IfNoneMatch added in v0.57.0 

func (c *AdminProjectsLocationsReservationsListCall) IfNoneMatch(entityTag string) *AdminProjectsLocationsReservationsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*AdminProjectsLocationsReservationsListCall) PageSize added in v0.57.0 

func (c *AdminProjectsLocationsReservationsListCall) PageSize(pageSize int64) *AdminProjectsLocationsReservationsListCall

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

func (*AdminProjectsLocationsReservationsListCall) PageToken added in v0.57.0 

func (c *AdminProjectsLocationsReservationsListCall) PageToken(pageToken string) *AdminProjectsLocationsReservationsListCall

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

func (*AdminProjectsLocationsReservationsListCall) Pages added in v0.57.0 

func (c *AdminProjectsLocationsReservationsListCall) Pages(ctx context.Context, f func(*ListReservationsResponse) error) error

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.

type AdminProjectsLocationsReservationsPatchCall added in v0.57.0 

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

func (*AdminProjectsLocationsReservationsPatchCall) Context added in v0.57.0 

func (c *AdminProjectsLocationsReservationsPatchCall) Context(ctx context.Context) *AdminProjectsLocationsReservationsPatchCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AdminProjectsLocationsReservationsPatchCall) Do added in v0.57.0 

func (c *AdminProjectsLocationsReservationsPatchCall) Do(opts ...googleapi.CallOption) (*Reservation, error)

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

func (*AdminProjectsLocationsReservationsPatchCall) Fields added in v0.57.0 

func (c *AdminProjectsLocationsReservationsPatchCall) Fields(s ...googleapi.Field) *AdminProjectsLocationsReservationsPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AdminProjectsLocationsReservationsPatchCall) Header added in v0.57.0 

func (c *AdminProjectsLocationsReservationsPatchCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AdminProjectsLocationsReservationsPatchCall) UpdateMask added in v0.57.0 

func (c *AdminProjectsLocationsReservationsPatchCall) UpdateMask(updateMask string) *AdminProjectsLocationsReservationsPatchCall

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

type AdminProjectsLocationsReservationsService added in v0.57.0 

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

func NewAdminProjectsLocationsReservationsService added in v0.57.0 

func NewAdminProjectsLocationsReservationsService(s *Service) *AdminProjectsLocationsReservationsService

func (*AdminProjectsLocationsReservationsService) Create added in v0.57.0 

func (r *AdminProjectsLocationsReservationsService) Create(parent string, reservation *Reservation) *AdminProjectsLocationsReservationsCreateCall

Create: Creates a new reservation.

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

func (*AdminProjectsLocationsReservationsService) Delete added in v0.57.0 

func (r *AdminProjectsLocationsReservationsService) Delete(name string) *AdminProjectsLocationsReservationsDeleteCall

Delete: Deletes the specified reservation.

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

func (*AdminProjectsLocationsReservationsService) Get added in v0.57.0 

func (r *AdminProjectsLocationsReservationsService) Get(name string) *AdminProjectsLocationsReservationsGetCall

Get: Returns the reservation configuration.

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

func (*AdminProjectsLocationsReservationsService) List added in v0.57.0 

func (r *AdminProjectsLocationsReservationsService) List(parent string) *AdminProjectsLocationsReservationsListCall

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) Patch added in v0.57.0 

func (r *AdminProjectsLocationsReservationsService) Patch(name string, reservation *Reservation) *AdminProjectsLocationsReservationsPatchCall

Patch: Updates properties of the specified reservation.

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

type AdminProjectsLocationsReservationsTopicsListCall added in v0.57.0 

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

func (*AdminProjectsLocationsReservationsTopicsListCall) Context added in v0.57.0 

func (c *AdminProjectsLocationsReservationsTopicsListCall) Context(ctx context.Context) *AdminProjectsLocationsReservationsTopicsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AdminProjectsLocationsReservationsTopicsListCall) Do added in v0.57.0 

func (c *AdminProjectsLocationsReservationsTopicsListCall) Do(opts ...googleapi.CallOption) (*ListReservationTopicsResponse, error)

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

func (*AdminProjectsLocationsReservationsTopicsListCall) Fields added in v0.57.0 

func (c *AdminProjectsLocationsReservationsTopicsListCall) Fields(s ...googleapi.Field) *AdminProjectsLocationsReservationsTopicsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AdminProjectsLocationsReservationsTopicsListCall) Header added in v0.57.0 

func (c *AdminProjectsLocationsReservationsTopicsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AdminProjectsLocationsReservationsTopicsListCall) IfNoneMatch added in v0.57.0 

func (c *AdminProjectsLocationsReservationsTopicsListCall) IfNoneMatch(entityTag string) *AdminProjectsLocationsReservationsTopicsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*AdminProjectsLocationsReservationsTopicsListCall) PageSize added in v0.57.0 

func (c *AdminProjectsLocationsReservationsTopicsListCall) PageSize(pageSize int64) *AdminProjectsLocationsReservationsTopicsListCall

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

func (*AdminProjectsLocationsReservationsTopicsListCall) PageToken added in v0.57.0 

func (c *AdminProjectsLocationsReservationsTopicsListCall) PageToken(pageToken string) *AdminProjectsLocationsReservationsTopicsListCall

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

func (*AdminProjectsLocationsReservationsTopicsListCall) Pages added in v0.57.0 

func (c *AdminProjectsLocationsReservationsTopicsListCall) Pages(ctx context.Context, f func(*ListReservationTopicsResponse) error) error

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.

type AdminProjectsLocationsReservationsTopicsService added in v0.57.0 

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

func NewAdminProjectsLocationsReservationsTopicsService added in v0.57.0 

func NewAdminProjectsLocationsReservationsTopicsService(s *Service) *AdminProjectsLocationsReservationsTopicsService

func (*AdminProjectsLocationsReservationsTopicsService) List added in v0.57.0 

func (r *AdminProjectsLocationsReservationsTopicsService) List(name string) *AdminProjectsLocationsReservationsTopicsListCall

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/{reserva tion_id}.

type AdminProjectsLocationsService 

type AdminProjectsLocationsService struct {
	Operations *AdminProjectsLocationsOperationsService

	Reservations *AdminProjectsLocationsReservationsService

	Subscriptions *AdminProjectsLocationsSubscriptionsService

	Topics *AdminProjectsLocationsTopicsService
	// contains filtered or unexported fields
}

func NewAdminProjectsLocationsService 

func NewAdminProjectsLocationsService(s *Service) *AdminProjectsLocationsService

type AdminProjectsLocationsSubscriptionsCreateCall 

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

func (*AdminProjectsLocationsSubscriptionsCreateCall) Context 

func (c *AdminProjectsLocationsSubscriptionsCreateCall) Context(ctx context.Context) *AdminProjectsLocationsSubscriptionsCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AdminProjectsLocationsSubscriptionsCreateCall) Do 

func (c *AdminProjectsLocationsSubscriptionsCreateCall) Do(opts ...googleapi.CallOption) (*Subscription, error)

Do executes the "pubsublite.admin.projects.locations.subscriptions.create" call. Exactly one of *Subscription or error will be non-nil. 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 check whether the returned error was because http.StatusNotModified was returned.

func (*AdminProjectsLocationsSubscriptionsCreateCall) Fields 

func (c *AdminProjectsLocationsSubscriptionsCreateCall) Fields(s ...googleapi.Field) *AdminProjectsLocationsSubscriptionsCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AdminProjectsLocationsSubscriptionsCreateCall) Header 

func (c *AdminProjectsLocationsSubscriptionsCreateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AdminProjectsLocationsSubscriptionsCreateCall) SkipBacklog added in v0.43.0 

func (c *AdminProjectsLocationsSubscriptionsCreateCall) SkipBacklog(skipBacklog bool) *AdminProjectsLocationsSubscriptionsCreateCall

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

func (*AdminProjectsLocationsSubscriptionsCreateCall) SubscriptionId 

func (c *AdminProjectsLocationsSubscriptionsCreateCall) SubscriptionId(subscriptionId string) *AdminProjectsLocationsSubscriptionsCreateCall

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

type AdminProjectsLocationsSubscriptionsDeleteCall 

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

func (*AdminProjectsLocationsSubscriptionsDeleteCall) Context 

func (c *AdminProjectsLocationsSubscriptionsDeleteCall) Context(ctx context.Context) *AdminProjectsLocationsSubscriptionsDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AdminProjectsLocationsSubscriptionsDeleteCall) Do 

func (c *AdminProjectsLocationsSubscriptionsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

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

func (*AdminProjectsLocationsSubscriptionsDeleteCall) Fields 

func (c *AdminProjectsLocationsSubscriptionsDeleteCall) Fields(s ...googleapi.Field) *AdminProjectsLocationsSubscriptionsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AdminProjectsLocationsSubscriptionsDeleteCall) Header 

func (c *AdminProjectsLocationsSubscriptionsDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type AdminProjectsLocationsSubscriptionsGetCall 

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

func (*AdminProjectsLocationsSubscriptionsGetCall) Context 

func (c *AdminProjectsLocationsSubscriptionsGetCall) Context(ctx context.Context) *AdminProjectsLocationsSubscriptionsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AdminProjectsLocationsSubscriptionsGetCall) Do 

func (c *AdminProjectsLocationsSubscriptionsGetCall) Do(opts ...googleapi.CallOption) (*Subscription, error)

Do executes the "pubsublite.admin.projects.locations.subscriptions.get" call. Exactly one of *Subscription or error will be non-nil. 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 check whether the returned error was because http.StatusNotModified was returned.

func (*AdminProjectsLocationsSubscriptionsGetCall) Fields 

func (c *AdminProjectsLocationsSubscriptionsGetCall) Fields(s ...googleapi.Field) *AdminProjectsLocationsSubscriptionsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AdminProjectsLocationsSubscriptionsGetCall) Header 

func (c *AdminProjectsLocationsSubscriptionsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AdminProjectsLocationsSubscriptionsGetCall) IfNoneMatch 

func (c *AdminProjectsLocationsSubscriptionsGetCall) IfNoneMatch(entityTag string) *AdminProjectsLocationsSubscriptionsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type AdminProjectsLocationsSubscriptionsListCall 

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

func (*AdminProjectsLocationsSubscriptionsListCall) Context 

func (c *AdminProjectsLocationsSubscriptionsListCall) Context(ctx context.Context) *AdminProjectsLocationsSubscriptionsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AdminProjectsLocationsSubscriptionsListCall) Do 

func (c *AdminProjectsLocationsSubscriptionsListCall) Do(opts ...googleapi.CallOption) (*ListSubscriptionsResponse, error)

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

func (*AdminProjectsLocationsSubscriptionsListCall) Fields 

func (c *AdminProjectsLocationsSubscriptionsListCall) Fields(s ...googleapi.Field) *AdminProjectsLocationsSubscriptionsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AdminProjectsLocationsSubscriptionsListCall) Header 

func (c *AdminProjectsLocationsSubscriptionsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AdminProjectsLocationsSubscriptionsListCall) IfNoneMatch 

func (c *AdminProjectsLocationsSubscriptionsListCall) IfNoneMatch(entityTag string) *AdminProjectsLocationsSubscriptionsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*AdminProjectsLocationsSubscriptionsListCall) PageSize 

func (c *AdminProjectsLocationsSubscriptionsListCall) PageSize(pageSize int64) *AdminProjectsLocationsSubscriptionsListCall

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

func (*AdminProjectsLocationsSubscriptionsListCall) PageToken 

func (c *AdminProjectsLocationsSubscriptionsListCall) PageToken(pageToken string) *AdminProjectsLocationsSubscriptionsListCall

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

func (*AdminProjectsLocationsSubscriptionsListCall) Pages 

func (c *AdminProjectsLocationsSubscriptionsListCall) Pages(ctx context.Context, f func(*ListSubscriptionsResponse) error) error

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.

type AdminProjectsLocationsSubscriptionsPatchCall 

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

func (*AdminProjectsLocationsSubscriptionsPatchCall) Context 

func (c *AdminProjectsLocationsSubscriptionsPatchCall) Context(ctx context.Context) *AdminProjectsLocationsSubscriptionsPatchCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AdminProjectsLocationsSubscriptionsPatchCall) Do 

func (c *AdminProjectsLocationsSubscriptionsPatchCall) Do(opts ...googleapi.CallOption) (*Subscription, error)

Do executes the "pubsublite.admin.projects.locations.subscriptions.patch" call. Exactly one of *Subscription or error will be non-nil. 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 check whether the returned error was because http.StatusNotModified was returned.

func (*AdminProjectsLocationsSubscriptionsPatchCall) Fields 

func (c *AdminProjectsLocationsSubscriptionsPatchCall) Fields(s ...googleapi.Field) *AdminProjectsLocationsSubscriptionsPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AdminProjectsLocationsSubscriptionsPatchCall) Header 

func (c *AdminProjectsLocationsSubscriptionsPatchCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AdminProjectsLocationsSubscriptionsPatchCall) UpdateMask 

func (c *AdminProjectsLocationsSubscriptionsPatchCall) UpdateMask(updateMask string) *AdminProjectsLocationsSubscriptionsPatchCall

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

type AdminProjectsLocationsSubscriptionsSeekCall added in v0.53.0 

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

func (*AdminProjectsLocationsSubscriptionsSeekCall) Context added in v0.53.0 

func (c *AdminProjectsLocationsSubscriptionsSeekCall) Context(ctx context.Context) *AdminProjectsLocationsSubscriptionsSeekCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AdminProjectsLocationsSubscriptionsSeekCall) Do added in v0.53.0 

func (c *AdminProjectsLocationsSubscriptionsSeekCall) Do(opts ...googleapi.CallOption) (*Operation, error)

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

func (*AdminProjectsLocationsSubscriptionsSeekCall) Fields added in v0.53.0 

func (c *AdminProjectsLocationsSubscriptionsSeekCall) Fields(s ...googleapi.Field) *AdminProjectsLocationsSubscriptionsSeekCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AdminProjectsLocationsSubscriptionsSeekCall) Header added in v0.53.0 

func (c *AdminProjectsLocationsSubscriptionsSeekCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type AdminProjectsLocationsSubscriptionsService 

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

func NewAdminProjectsLocationsSubscriptionsService 

func NewAdminProjectsLocationsSubscriptionsService(s *Service) *AdminProjectsLocationsSubscriptionsService

func (*AdminProjectsLocationsSubscriptionsService) Create 

func (r *AdminProjectsLocationsSubscriptionsService) Create(parent string, subscription *Subscription) *AdminProjectsLocationsSubscriptionsCreateCall

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 

func (r *AdminProjectsLocationsSubscriptionsService) Delete(name string) *AdminProjectsLocationsSubscriptionsDeleteCall

Delete: Deletes the specified subscription.

- name: The name of the subscription to delete.

func (*AdminProjectsLocationsSubscriptionsService) Get 

func (r *AdminProjectsLocationsSubscriptionsService) Get(name string) *AdminProjectsLocationsSubscriptionsGetCall

Get: Returns the subscription configuration.

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

func (*AdminProjectsLocationsSubscriptionsService) List 

func (r *AdminProjectsLocationsSubscriptionsService) List(parent string) *AdminProjectsLocationsSubscriptionsListCall

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 

func (r *AdminProjectsLocationsSubscriptionsService) Patch(name string, subscription *Subscription) *AdminProjectsLocationsSubscriptionsPatchCall

Patch: Updates properties of the specified subscription.

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

func (*AdminProjectsLocationsSubscriptionsService) Seek added in v0.53.0 

func (r *AdminProjectsLocationsSubscriptionsService) Seek(name string, seeksubscriptionrequest *SeekSubscriptionRequest) *AdminProjectsLocationsSubscriptionsSeekCall

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

- name: The name of the subscription to seek.

type AdminProjectsLocationsTopicsCreateCall 

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

func (*AdminProjectsLocationsTopicsCreateCall) Context 

func (c *AdminProjectsLocationsTopicsCreateCall) Context(ctx context.Context) *AdminProjectsLocationsTopicsCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AdminProjectsLocationsTopicsCreateCall) Do 

func (c *AdminProjectsLocationsTopicsCreateCall) Do(opts ...googleapi.CallOption) (*Topic, error)

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

func (*AdminProjectsLocationsTopicsCreateCall) Fields 

func (c *AdminProjectsLocationsTopicsCreateCall) Fields(s ...googleapi.Field) *AdminProjectsLocationsTopicsCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AdminProjectsLocationsTopicsCreateCall) Header 

func (c *AdminProjectsLocationsTopicsCreateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AdminProjectsLocationsTopicsCreateCall) TopicId 

func (c *AdminProjectsLocationsTopicsCreateCall) TopicId(topicId string) *AdminProjectsLocationsTopicsCreateCall

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

type AdminProjectsLocationsTopicsDeleteCall 

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

func (*AdminProjectsLocationsTopicsDeleteCall) Context 

func (c *AdminProjectsLocationsTopicsDeleteCall) Context(ctx context.Context) *AdminProjectsLocationsTopicsDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AdminProjectsLocationsTopicsDeleteCall) Do 

func (c *AdminProjectsLocationsTopicsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

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

func (*AdminProjectsLocationsTopicsDeleteCall) Fields 

func (c *AdminProjectsLocationsTopicsDeleteCall) Fields(s ...googleapi.Field) *AdminProjectsLocationsTopicsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AdminProjectsLocationsTopicsDeleteCall) Header 

func (c *AdminProjectsLocationsTopicsDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type AdminProjectsLocationsTopicsGetCall 

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

func (*AdminProjectsLocationsTopicsGetCall) Context 

func (c *AdminProjectsLocationsTopicsGetCall) Context(ctx context.Context) *AdminProjectsLocationsTopicsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AdminProjectsLocationsTopicsGetCall) Do 

func (c *AdminProjectsLocationsTopicsGetCall) Do(opts ...googleapi.CallOption) (*Topic, error)

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

func (*AdminProjectsLocationsTopicsGetCall) Fields 

func (c *AdminProjectsLocationsTopicsGetCall) Fields(s ...googleapi.Field) *AdminProjectsLocationsTopicsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AdminProjectsLocationsTopicsGetCall) Header 

func (c *AdminProjectsLocationsTopicsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AdminProjectsLocationsTopicsGetCall) IfNoneMatch 

func (c *AdminProjectsLocationsTopicsGetCall) IfNoneMatch(entityTag string) *AdminProjectsLocationsTopicsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type AdminProjectsLocationsTopicsGetPartitionsCall 

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

func (*AdminProjectsLocationsTopicsGetPartitionsCall) Context 

func (c *AdminProjectsLocationsTopicsGetPartitionsCall) Context(ctx context.Context) *AdminProjectsLocationsTopicsGetPartitionsCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AdminProjectsLocationsTopicsGetPartitionsCall) Do 

func (c *AdminProjectsLocationsTopicsGetPartitionsCall) Do(opts ...googleapi.CallOption) (*TopicPartitions, error)

Do executes the "pubsublite.admin.projects.locations.topics.getPartitions" call. Exactly one of *TopicPartitions or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TopicPartitions.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AdminProjectsLocationsTopicsGetPartitionsCall) Fields 

func (c *AdminProjectsLocationsTopicsGetPartitionsCall) Fields(s ...googleapi.Field) *AdminProjectsLocationsTopicsGetPartitionsCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AdminProjectsLocationsTopicsGetPartitionsCall) Header 

func (c *AdminProjectsLocationsTopicsGetPartitionsCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AdminProjectsLocationsTopicsGetPartitionsCall) IfNoneMatch 

func (c *AdminProjectsLocationsTopicsGetPartitionsCall) IfNoneMatch(entityTag string) *AdminProjectsLocationsTopicsGetPartitionsCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type AdminProjectsLocationsTopicsListCall 

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

func (*AdminProjectsLocationsTopicsListCall) Context 

func (c *AdminProjectsLocationsTopicsListCall) Context(ctx context.Context) *AdminProjectsLocationsTopicsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AdminProjectsLocationsTopicsListCall) Do 

func (c *AdminProjectsLocationsTopicsListCall) Do(opts ...googleapi.CallOption) (*ListTopicsResponse, error)

Do executes the "pubsublite.admin.projects.locations.topics.list" call. Exactly one of *ListTopicsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListTopicsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*AdminProjectsLocationsTopicsListCall) Fields 

func (c *AdminProjectsLocationsTopicsListCall) Fields(s ...googleapi.Field) *AdminProjectsLocationsTopicsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AdminProjectsLocationsTopicsListCall) Header 

func (c *AdminProjectsLocationsTopicsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AdminProjectsLocationsTopicsListCall) IfNoneMatch 

func (c *AdminProjectsLocationsTopicsListCall) IfNoneMatch(entityTag string) *AdminProjectsLocationsTopicsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*AdminProjectsLocationsTopicsListCall) PageSize 

func (c *AdminProjectsLocationsTopicsListCall) PageSize(pageSize int64) *AdminProjectsLocationsTopicsListCall

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

func (*AdminProjectsLocationsTopicsListCall) PageToken 

func (c *AdminProjectsLocationsTopicsListCall) PageToken(pageToken string) *AdminProjectsLocationsTopicsListCall

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

func (*AdminProjectsLocationsTopicsListCall) Pages 

func (c *AdminProjectsLocationsTopicsListCall) Pages(ctx context.Context, f func(*ListTopicsResponse) error) error

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.

type AdminProjectsLocationsTopicsPatchCall 

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

func (*AdminProjectsLocationsTopicsPatchCall) Context 

func (c *AdminProjectsLocationsTopicsPatchCall) Context(ctx context.Context) *AdminProjectsLocationsTopicsPatchCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AdminProjectsLocationsTopicsPatchCall) Do 

func (c *AdminProjectsLocationsTopicsPatchCall) Do(opts ...googleapi.CallOption) (*Topic, error)

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

func (*AdminProjectsLocationsTopicsPatchCall) Fields 

func (c *AdminProjectsLocationsTopicsPatchCall) Fields(s ...googleapi.Field) *AdminProjectsLocationsTopicsPatchCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AdminProjectsLocationsTopicsPatchCall) Header 

func (c *AdminProjectsLocationsTopicsPatchCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AdminProjectsLocationsTopicsPatchCall) UpdateMask 

func (c *AdminProjectsLocationsTopicsPatchCall) UpdateMask(updateMask string) *AdminProjectsLocationsTopicsPatchCall

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

type AdminProjectsLocationsTopicsService 

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

func NewAdminProjectsLocationsTopicsService 

func NewAdminProjectsLocationsTopicsService(s *Service) *AdminProjectsLocationsTopicsService

func (*AdminProjectsLocationsTopicsService) Create 

func (r *AdminProjectsLocationsTopicsService) Create(parent string, topic *Topic) *AdminProjectsLocationsTopicsCreateCall

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 

func (r *AdminProjectsLocationsTopicsService) Delete(name string) *AdminProjectsLocationsTopicsDeleteCall

Delete: Deletes the specified topic.

- name: The name of the topic to delete.

func (*AdminProjectsLocationsTopicsService) Get 

func (r *AdminProjectsLocationsTopicsService) Get(name string) *AdminProjectsLocationsTopicsGetCall

Get: Returns the topic configuration.

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

func (*AdminProjectsLocationsTopicsService) GetPartitions 

func (r *AdminProjectsLocationsTopicsService) GetPartitions(name string) *AdminProjectsLocationsTopicsGetPartitionsCall

GetPartitions: Returns the partition information for the requested topic.

- name: The topic whose partition information to return.

func (*AdminProjectsLocationsTopicsService) List 

func (r *AdminProjectsLocationsTopicsService) List(parent string) *AdminProjectsLocationsTopicsListCall

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 

func (r *AdminProjectsLocationsTopicsService) Patch(name string, topic *Topic) *AdminProjectsLocationsTopicsPatchCall

Patch: Updates properties of the specified topic.

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

type AdminProjectsLocationsTopicsSubscriptionsListCall 

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

func (*AdminProjectsLocationsTopicsSubscriptionsListCall) Context 

func (c *AdminProjectsLocationsTopicsSubscriptionsListCall) Context(ctx context.Context) *AdminProjectsLocationsTopicsSubscriptionsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*AdminProjectsLocationsTopicsSubscriptionsListCall) Do 

func (c *AdminProjectsLocationsTopicsSubscriptionsListCall) Do(opts ...googleapi.CallOption) (*ListTopicSubscriptionsResponse, error)

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

func (*AdminProjectsLocationsTopicsSubscriptionsListCall) Fields 

func (c *AdminProjectsLocationsTopicsSubscriptionsListCall) Fields(s ...googleapi.Field) *AdminProjectsLocationsTopicsSubscriptionsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*AdminProjectsLocationsTopicsSubscriptionsListCall) Header 

func (c *AdminProjectsLocationsTopicsSubscriptionsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*AdminProjectsLocationsTopicsSubscriptionsListCall) IfNoneMatch 

func (c *AdminProjectsLocationsTopicsSubscriptionsListCall) IfNoneMatch(entityTag string) *AdminProjectsLocationsTopicsSubscriptionsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*AdminProjectsLocationsTopicsSubscriptionsListCall) PageSize 

func (c *AdminProjectsLocationsTopicsSubscriptionsListCall) PageSize(pageSize int64) *AdminProjectsLocationsTopicsSubscriptionsListCall

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

func (*AdminProjectsLocationsTopicsSubscriptionsListCall) PageToken 

func (c *AdminProjectsLocationsTopicsSubscriptionsListCall) PageToken(pageToken string) *AdminProjectsLocationsTopicsSubscriptionsListCall

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

func (*AdminProjectsLocationsTopicsSubscriptionsListCall) Pages 

func (c *AdminProjectsLocationsTopicsSubscriptionsListCall) Pages(ctx context.Context, f func(*ListTopicSubscriptionsResponse) error) error

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.

type AdminProjectsLocationsTopicsSubscriptionsService 

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

func NewAdminProjectsLocationsTopicsSubscriptionsService 

func NewAdminProjectsLocationsTopicsSubscriptionsService(s *Service) *AdminProjectsLocationsTopicsSubscriptionsService

func (*AdminProjectsLocationsTopicsSubscriptionsService) List 

func (r *AdminProjectsLocationsTopicsSubscriptionsService) List(name string) *AdminProjectsLocationsTopicsSubscriptionsListCall

List: Lists the subscriptions attached to the specified topic.

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

type AdminProjectsService 

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

func NewAdminProjectsService 

func NewAdminProjectsService(s *Service) *AdminProjectsService

type AdminService 

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

func NewAdminService 

func NewAdminService(s *Service) *AdminService

type CancelOperationRequest added in v0.53.0 

type CancelOperationRequest struct {
}

CancelOperationRequest: The request message for Operations.CancelOperation.

type Capacity 

type Capacity struct {
	// PublishMibPerSec: Publish throughput capacity per partition in MiB/s.
	// Must be >= 4 and <= 16.
	PublishMibPerSec int64 `json:"publishMibPerSec,omitempty"`

	// SubscribeMibPerSec: Subscribe throughput capacity per partition in
	// MiB/s. Must be >= 4 and <= 32.
	SubscribeMibPerSec int64 `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

Capacity: The throughput capacity configuration for each partition.

func (*Capacity) MarshalJSON 

func (s *Capacity) MarshalJSON() ([]byte, error)

type CommitCursorRequest added in v0.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).
	Partition int64 `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CommitCursorRequest: Request for CommitCursor.

func (*CommitCursorRequest) MarshalJSON added in v0.47.0 

func (s *CommitCursorRequest) MarshalJSON() ([]byte, error)

type CommitCursorResponse added in v0.47.0 

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

CommitCursorResponse: Response for CommitCursor.

type ComputeHeadCursorRequest added in v0.40.0 

type ComputeHeadCursorRequest struct {
	// Partition: Required. The partition for which we should compute the
	// head cursor.
	Partition int64 `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ComputeHeadCursorRequest: Compute the current head cursor for a partition.

func (*ComputeHeadCursorRequest) MarshalJSON added in v0.40.0 

func (s *ComputeHeadCursorRequest) MarshalJSON() ([]byte, error)

type ComputeHeadCursorResponse added in v0.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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*ComputeHeadCursorResponse) MarshalJSON added in v0.40.0 

func (s *ComputeHeadCursorResponse) MarshalJSON() ([]byte, error)

type ComputeMessageStatsRequest added in v0.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.
	Partition int64 `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*ComputeMessageStatsRequest) MarshalJSON added in v0.33.0 

func (s *ComputeMessageStatsRequest) MarshalJSON() ([]byte, error)

type ComputeMessageStatsResponse added in v0.33.0 

type ComputeMessageStatsResponse struct {
	// MessageBytes: The number of quota bytes accounted to these messages.
	MessageBytes int64 `json:"messageBytes,omitempty,string"`

	// MessageCount: The count of messages.
	MessageCount int64 `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.
	MinimumEventTime string `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.
	MinimumPublishTime string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*ComputeMessageStatsResponse) MarshalJSON added in v0.33.0 

func (s *ComputeMessageStatsResponse) MarshalJSON() ([]byte, error)

type ComputeTimeCursorRequest added in v0.47.0 

type ComputeTimeCursorRequest struct {
	// Partition: Required. The partition for which we should compute the
	// cursor.
	Partition int64 `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*ComputeTimeCursorRequest) MarshalJSON added in v0.47.0 

func (s *ComputeTimeCursorRequest) MarshalJSON() ([]byte, error)

type ComputeTimeCursorResponse added in v0.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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*ComputeTimeCursorResponse) MarshalJSON added in v0.47.0 

func (s *ComputeTimeCursorResponse) MarshalJSON() ([]byte, error)

type Cursor 

type Cursor struct {
	// Offset: The offset of a message within a topic partition. Must be
	// greater than or equal 0.
	Offset int64 `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*Cursor) MarshalJSON 

func (s *Cursor) MarshalJSON() ([]byte, error)

type CursorProjectsLocationsService 

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

func NewCursorProjectsLocationsService 

func NewCursorProjectsLocationsService(s *Service) *CursorProjectsLocationsService

type CursorProjectsLocationsSubscriptionsCommitCursorCall added in v0.47.0 

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

func (*CursorProjectsLocationsSubscriptionsCommitCursorCall) Context added in v0.47.0 

func (c *CursorProjectsLocationsSubscriptionsCommitCursorCall) Context(ctx context.Context) *CursorProjectsLocationsSubscriptionsCommitCursorCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CursorProjectsLocationsSubscriptionsCommitCursorCall) Do added in v0.47.0 

func (c *CursorProjectsLocationsSubscriptionsCommitCursorCall) Do(opts ...googleapi.CallOption) (*CommitCursorResponse, error)

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

func (*CursorProjectsLocationsSubscriptionsCommitCursorCall) Fields added in v0.47.0 

func (c *CursorProjectsLocationsSubscriptionsCommitCursorCall) Fields(s ...googleapi.Field) *CursorProjectsLocationsSubscriptionsCommitCursorCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*CursorProjectsLocationsSubscriptionsCommitCursorCall) Header added in v0.47.0 

func (c *CursorProjectsLocationsSubscriptionsCommitCursorCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type CursorProjectsLocationsSubscriptionsCursorsListCall 

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

func (*CursorProjectsLocationsSubscriptionsCursorsListCall) Context 

func (c *CursorProjectsLocationsSubscriptionsCursorsListCall) Context(ctx context.Context) *CursorProjectsLocationsSubscriptionsCursorsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*CursorProjectsLocationsSubscriptionsCursorsListCall) Do 

func (c *CursorProjectsLocationsSubscriptionsCursorsListCall) Do(opts ...googleapi.CallOption) (*ListPartitionCursorsResponse, error)

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

func (*CursorProjectsLocationsSubscriptionsCursorsListCall) Fields 

func (c *CursorProjectsLocationsSubscriptionsCursorsListCall) Fields(s ...googleapi.Field) *CursorProjectsLocationsSubscriptionsCursorsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*CursorProjectsLocationsSubscriptionsCursorsListCall) Header 

func (c *CursorProjectsLocationsSubscriptionsCursorsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*CursorProjectsLocationsSubscriptionsCursorsListCall) IfNoneMatch 

func (c *CursorProjectsLocationsSubscriptionsCursorsListCall) IfNoneMatch(entityTag string) *CursorProjectsLocationsSubscriptionsCursorsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*CursorProjectsLocationsSubscriptionsCursorsListCall) PageSize 

func (c *CursorProjectsLocationsSubscriptionsCursorsListCall) PageSize(pageSize int64) *CursorProjectsLocationsSubscriptionsCursorsListCall

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

func (*CursorProjectsLocationsSubscriptionsCursorsListCall) PageToken 

func (c *CursorProjectsLocationsSubscriptionsCursorsListCall) PageToken(pageToken string) *CursorProjectsLocationsSubscriptionsCursorsListCall

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

func (*CursorProjectsLocationsSubscriptionsCursorsListCall) Pages 

func (c *CursorProjectsLocationsSubscriptionsCursorsListCall) Pages(ctx context.Context, f func(*ListPartitionCursorsResponse) error) error

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.

type CursorProjectsLocationsSubscriptionsCursorsService 

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

func NewCursorProjectsLocationsSubscriptionsCursorsService 

func NewCursorProjectsLocationsSubscriptionsCursorsService(s *Service) *CursorProjectsLocationsSubscriptionsCursorsService

func (*CursorProjectsLocationsSubscriptionsCursorsService) List 

func (r *CursorProjectsLocationsSubscriptionsCursorsService) List(parent string) *CursorProjectsLocationsSubscriptionsCursorsListCall

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/{subsc ription_id}`.

type CursorProjectsLocationsSubscriptionsService 

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

func NewCursorProjectsLocationsSubscriptionsService 

func NewCursorProjectsLocationsSubscriptionsService(s *Service) *CursorProjectsLocationsSubscriptionsService

func (*CursorProjectsLocationsSubscriptionsService) CommitCursor added in v0.47.0 

func (r *CursorProjectsLocationsSubscriptionsService) CommitCursor(subscription string, commitcursorrequest *CommitCursorRequest) *CursorProjectsLocationsSubscriptionsCommitCursorCall

CommitCursor: Updates the committed cursor.

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

type CursorProjectsService 

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

func NewCursorProjectsService 

func NewCursorProjectsService(s *Service) *CursorProjectsService

type CursorService 

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

func NewCursorService 

func NewCursorService(s *Service) *CursorService

type DeliveryConfig 

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.
	DeliveryRequirement string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

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

func (*DeliveryConfig) MarshalJSON 

func (s *DeliveryConfig) MarshalJSON() ([]byte, error)

type Empty 

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 defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

type ExportConfig added in v0.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.
	CurrentState string `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.
	DeadLetterTopic string `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.
	DesiredState string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*ExportConfig) MarshalJSON added in v0.106.0 

func (s *ExportConfig) MarshalJSON() ([]byte, error)

type ListOperationsResponse added in v0.53.0 

type ListOperationsResponse struct {
	// NextPageToken: The standard List next-page token.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Operations: A list of operations that matches the specified filter in
	// the request.
	Operations []*Operation `json:"operations,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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListOperationsResponse: The response message for Operations.ListOperations.

func (*ListOperationsResponse) MarshalJSON added in v0.53.0 

func (s *ListOperationsResponse) MarshalJSON() ([]byte, error)

type ListPartitionCursorsResponse 

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.
	NextPageToken string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListPartitionCursorsResponse: Response for ListPartitionCursors

func (*ListPartitionCursorsResponse) MarshalJSON 

func (s *ListPartitionCursorsResponse) MarshalJSON() ([]byte, error)

type ListReservationTopicsResponse added in v0.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.
	NextPageToken string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListReservationTopicsResponse: Response for ListReservationTopics.

func (*ListReservationTopicsResponse) MarshalJSON added in v0.57.0 

func (s *ListReservationTopicsResponse) MarshalJSON() ([]byte, error)

type ListReservationsResponse added in v0.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.
	NextPageToken string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListReservationsResponse: Response for ListReservations.

func (*ListReservationsResponse) MarshalJSON added in v0.57.0 

func (s *ListReservationsResponse) MarshalJSON() ([]byte, error)

type ListSubscriptionsResponse 

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.
	NextPageToken string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListSubscriptionsResponse: Response for ListSubscriptions.

func (*ListSubscriptionsResponse) MarshalJSON 

func (s *ListSubscriptionsResponse) MarshalJSON() ([]byte, error)

type ListTopicSubscriptionsResponse 

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.
	NextPageToken string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListTopicSubscriptionsResponse: Response for ListTopicSubscriptions.

func (*ListTopicSubscriptionsResponse) MarshalJSON 

func (s *ListTopicSubscriptionsResponse) MarshalJSON() ([]byte, error)

type ListTopicsResponse 

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.
	NextPageToken string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListTopicsResponse: Response for ListTopics.

func (*ListTopicsResponse) MarshalJSON 

func (s *ListTopicsResponse) MarshalJSON() ([]byte, error)

type Operation added in v0.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.
	Done bool `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.
	Metadata googleapi.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}`.
	Name string `json:"name,omitempty"`

	// Response: The normal response of the operation in case of success. 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`.
	Response googleapi.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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*Operation) MarshalJSON added in v0.53.0 

func (s *Operation) MarshalJSON() ([]byte, error)

type OperationMetadata added in v0.53.0 

type OperationMetadata struct {
	// CreateTime: The time the operation was created.
	CreateTime string `json:"createTime,omitempty"`

	// EndTime: The time the operation finished running. Not set if the
	// operation has not completed.
	EndTime string `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/{subscrip
	// tion_id}
	Target string `json:"target,omitempty"`

	// Verb: Name of the verb executed by the operation.
	Verb string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

OperationMetadata: Metadata for long running operations.

func (*OperationMetadata) MarshalJSON added in v0.53.0 

func (s *OperationMetadata) MarshalJSON() ([]byte, error)

type PartitionConfig 

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_capacity
	Count int64 `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].
	Scale int64 `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

PartitionConfig: The settings for a topic's partitions.

func (*PartitionConfig) MarshalJSON 

func (s *PartitionConfig) MarshalJSON() ([]byte, error)

type PartitionCursor 

type PartitionCursor struct {
	// Cursor: The value of the cursor.
	Cursor *Cursor `json:"cursor,omitempty"`

	// Partition: The partition this is for.
	Partition int64 `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*PartitionCursor) MarshalJSON 

func (s *PartitionCursor) MarshalJSON() ([]byte, error)

type PubSubConfig added in v0.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.
	Topic string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*PubSubConfig) MarshalJSON added in v0.106.0 

func (s *PubSubConfig) MarshalJSON() ([]byte, error)

type Reservation added in v0.57.0 

type Reservation struct {
	// Name: The name of the reservation. Structured like:
	// projects/{project_number}/locations/{location}/reservations/{reservati
	// on_id}
	Name string `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.
	ThroughputCapacity int64 `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Reservation: Metadata about a reservation resource.

func (*Reservation) MarshalJSON added in v0.57.0 

func (s *Reservation) MarshalJSON() ([]byte, error)

type ReservationConfig added in v0.57.0 

type ReservationConfig struct {
	// ThroughputReservation: The Reservation to use for this topic's
	// throughput capacity. Structured like:
	// projects/{project_number}/locations/{location}/reservations/{reservati
	// on_id}
	ThroughputReservation string `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. However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	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. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

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

func (*ReservationConfig) MarshalJSON added in v0.57.0 

func (s *ReservationConfig) MarshalJSON() ([]byte, error)

type RetentionConfig 

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`.
	PerPartitionBytes int64 `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`.
	Period string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

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

func (*RetentionConfig) MarshalJSON 

func (s *RetentionConfig) MarshalJSON() ([]byte, error)

type SeekSubscriptionRequest added in v0.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.
	NamedTarget string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

SeekSubscriptionRequest: Request for SeekSubscription.

func (*SeekSubscriptionRequest) MarshalJSON added in v0.53.0 

func (s *SeekSubscriptionRequest) MarshalJSON() ([]byte, error)

type SeekSubscriptionResponse added in v0.53.0 

type SeekSubscriptionResponse struct {
}

SeekSubscriptionResponse: Response for SeekSubscription long running operation.

type Service 

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Admin *AdminService

	Cursor *CursorService

	TopicStats *TopicStatsService
	// contains filtered or unexported fields
}

func New deprecated 

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.

func NewService 

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

NewService creates a new Service.

type Status added in v0.53.0 

type Status struct {
	// Code: The status code, which should be an enum value of
	// google.rpc.Code.
	Code int64 `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.
	Message string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*Status) MarshalJSON added in v0.53.0 

func (s *Status) MarshalJSON() ([]byte, error)

type Subscription 

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/{subscrip
	// tion_id}
	Name string `json:"name,omitempty"`

	// Topic: The name of the topic this subscription is attached to.
	// Structured like:
	// projects/{project_number}/locations/{location}/topics/{topic_id}
	Topic string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

Subscription: Metadata about a subscription resource.

func (*Subscription) MarshalJSON 

func (s *Subscription) MarshalJSON() ([]byte, error)

type TimeTarget added in v0.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.
	EventTime string `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`.
	PublishTime string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*TimeTarget) MarshalJSON added in v0.47.0 

func (s *TimeTarget) MarshalJSON() ([]byte, error)

type Topic 

type Topic struct {
	// Name: The name of the topic. Structured like:
	// projects/{project_number}/locations/{location}/topics/{topic_id}
	Name string `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Topic: Metadata about a topic resource.

func (*Topic) MarshalJSON 

func (s *Topic) MarshalJSON() ([]byte, error)

type TopicPartitions 

type TopicPartitions struct {
	// PartitionCount: The number of partitions in the topic.
	PartitionCount int64 `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. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	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. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

TopicPartitions: Response for GetTopicPartitions.

func (*TopicPartitions) MarshalJSON 

func (s *TopicPartitions) MarshalJSON() ([]byte, error)

type TopicStatsProjectsLocationsService added in v0.33.0 

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

func NewTopicStatsProjectsLocationsService added in v0.33.0 

func NewTopicStatsProjectsLocationsService(s *Service) *TopicStatsProjectsLocationsService

type TopicStatsProjectsLocationsTopicsComputeHeadCursorCall added in v0.40.0 

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

func (*TopicStatsProjectsLocationsTopicsComputeHeadCursorCall) Context added in v0.40.0 

func (c *TopicStatsProjectsLocationsTopicsComputeHeadCursorCall) Context(ctx context.Context) *TopicStatsProjectsLocationsTopicsComputeHeadCursorCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*TopicStatsProjectsLocationsTopicsComputeHeadCursorCall) Do added in v0.40.0 

func (c *TopicStatsProjectsLocationsTopicsComputeHeadCursorCall) Do(opts ...googleapi.CallOption) (*ComputeHeadCursorResponse, error)

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

func (*TopicStatsProjectsLocationsTopicsComputeHeadCursorCall) Fields added in v0.40.0 

func (c *TopicStatsProjectsLocationsTopicsComputeHeadCursorCall) Fields(s ...googleapi.Field) *TopicStatsProjectsLocationsTopicsComputeHeadCursorCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*TopicStatsProjectsLocationsTopicsComputeHeadCursorCall) Header added in v0.40.0 

func (c *TopicStatsProjectsLocationsTopicsComputeHeadCursorCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type TopicStatsProjectsLocationsTopicsComputeMessageStatsCall added in v0.33.0 

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

func (*TopicStatsProjectsLocationsTopicsComputeMessageStatsCall) Context added in v0.33.0 

func (c *TopicStatsProjectsLocationsTopicsComputeMessageStatsCall) Context(ctx context.Context) *TopicStatsProjectsLocationsTopicsComputeMessageStatsCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*TopicStatsProjectsLocationsTopicsComputeMessageStatsCall) Do added in v0.33.0 

func (c *TopicStatsProjectsLocationsTopicsComputeMessageStatsCall) Do(opts ...googleapi.CallOption) (*ComputeMessageStatsResponse, error)

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

func (*TopicStatsProjectsLocationsTopicsComputeMessageStatsCall) Fields added in v0.33.0 

func (c *TopicStatsProjectsLocationsTopicsComputeMessageStatsCall) Fields(s ...googleapi.Field) *TopicStatsProjectsLocationsTopicsComputeMessageStatsCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*TopicStatsProjectsLocationsTopicsComputeMessageStatsCall) Header added in v0.33.0 

func (c *TopicStatsProjectsLocationsTopicsComputeMessageStatsCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type TopicStatsProjectsLocationsTopicsComputeTimeCursorCall added in v0.47.0 

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

func (*TopicStatsProjectsLocationsTopicsComputeTimeCursorCall) Context added in v0.47.0 

func (c *TopicStatsProjectsLocationsTopicsComputeTimeCursorCall) Context(ctx context.Context) *TopicStatsProjectsLocationsTopicsComputeTimeCursorCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*TopicStatsProjectsLocationsTopicsComputeTimeCursorCall) Do added in v0.47.0 

func (c *TopicStatsProjectsLocationsTopicsComputeTimeCursorCall) Do(opts ...googleapi.CallOption) (*ComputeTimeCursorResponse, error)

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

func (*TopicStatsProjectsLocationsTopicsComputeTimeCursorCall) Fields added in v0.47.0 

func (c *TopicStatsProjectsLocationsTopicsComputeTimeCursorCall) Fields(s ...googleapi.Field) *TopicStatsProjectsLocationsTopicsComputeTimeCursorCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*TopicStatsProjectsLocationsTopicsComputeTimeCursorCall) Header added in v0.47.0 

func (c *TopicStatsProjectsLocationsTopicsComputeTimeCursorCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type TopicStatsProjectsLocationsTopicsService added in v0.33.0 

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

func NewTopicStatsProjectsLocationsTopicsService added in v0.33.0 

func NewTopicStatsProjectsLocationsTopicsService(s *Service) *TopicStatsProjectsLocationsTopicsService

func (*TopicStatsProjectsLocationsTopicsService) ComputeHeadCursor added in v0.40.0 

func (r *TopicStatsProjectsLocationsTopicsService) ComputeHeadCursor(topic string, computeheadcursorrequest *ComputeHeadCursorRequest) *TopicStatsProjectsLocationsTopicsComputeHeadCursorCall

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

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

func (*TopicStatsProjectsLocationsTopicsService) ComputeMessageStats added in v0.33.0 

func (r *TopicStatsProjectsLocationsTopicsService) ComputeMessageStats(topic string, computemessagestatsrequest *ComputeMessageStatsRequest) *TopicStatsProjectsLocationsTopicsComputeMessageStatsCall

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

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

func (*TopicStatsProjectsLocationsTopicsService) ComputeTimeCursor added in v0.47.0 

func (r *TopicStatsProjectsLocationsTopicsService) ComputeTimeCursor(topic string, computetimecursorrequest *ComputeTimeCursorRequest) *TopicStatsProjectsLocationsTopicsComputeTimeCursorCall

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

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

type TopicStatsProjectsService added in v0.33.0 

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

func NewTopicStatsProjectsService added in v0.33.0 

func NewTopicStatsProjectsService(s *Service) *TopicStatsProjectsService

type TopicStatsService added in v0.33.0 

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

func NewTopicStatsService added in v0.33.0 

func NewTopicStatsService(s *Service) *TopicStatsService

Source Files

View all Source files

Jump to

Keyboard shortcuts

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