go: cloud.google.com/go/pubsub/apiv1 Index | Examples | Files

package pubsub

import "cloud.google.com/go/pubsub/apiv1"

Package pubsub is an experimental, auto-generated package for the Google Cloud Pub/Sub API.

Provides reliable, many-to-many, asynchronous messaging between applications.

Use the client at cloud.google.com/go/pubsub in preference to this.

Index

Examples

Package Files

doc.go publisher_client.go subscriber_client.go

func DefaultAuthScopes Uses

func DefaultAuthScopes() []string

DefaultAuthScopes reports the authentication scopes required by this package.

func PublisherProjectPath Uses

func PublisherProjectPath(project string) string

PublisherProjectPath returns the path for the project resource.

func PublisherTopicPath Uses

func PublisherTopicPath(project, topic string) string

PublisherTopicPath returns the path for the topic resource.

func SubscriberProjectPath Uses

func SubscriberProjectPath(project string) string

SubscriberProjectPath returns the path for the project resource.

func SubscriberSnapshotPath Uses

func SubscriberSnapshotPath(project, snapshot string) string

SubscriberSnapshotPath returns the path for the snapshot resource.

func SubscriberSubscriptionPath Uses

func SubscriberSubscriptionPath(project, subscription string) string

SubscriberSubscriptionPath returns the path for the subscription resource.

func SubscriberTopicPath Uses

func SubscriberTopicPath(project, topic string) string

SubscriberTopicPath returns the path for the topic resource.

type PublisherCallOptions Uses

type PublisherCallOptions struct {
    CreateTopic            []gax.CallOption
    Publish                []gax.CallOption
    GetTopic               []gax.CallOption
    ListTopics             []gax.CallOption
    ListTopicSubscriptions []gax.CallOption
    DeleteTopic            []gax.CallOption
}

PublisherCallOptions contains the retry settings for each method of PublisherClient.

type PublisherClient Uses

type PublisherClient struct {

    // The call options for this service.
    CallOptions *PublisherCallOptions
    // contains filtered or unexported fields
}

PublisherClient is a client for interacting with Google Cloud Pub/Sub API.

func NewPublisherClient Uses

func NewPublisherClient(ctx context.Context, opts ...option.ClientOption) (*PublisherClient, error)

NewPublisherClient creates a new publisher client.

The service that an application uses to manipulate topics, and to send messages to a topic.

Code:

ctx := context.Background()
c, err := pubsub.NewPublisherClient(ctx)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use client.
_ = c

func (*PublisherClient) Close Uses

func (c *PublisherClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*PublisherClient) Connection Uses

func (c *PublisherClient) Connection() *grpc.ClientConn

Connection returns the client's connection to the API service.

func (*PublisherClient) CreateTopic Uses

func (c *PublisherClient) CreateTopic(ctx context.Context, req *pubsubpb.Topic, opts ...gax.CallOption) (*pubsubpb.Topic, error)

CreateTopic creates the given topic with the given name.

Code:

ctx := context.Background()
c, err := pubsub.NewPublisherClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &pubsubpb.Topic{
// TODO: Fill request struct fields.
}
resp, err := c.CreateTopic(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*PublisherClient) DeleteTopic Uses

func (c *PublisherClient) DeleteTopic(ctx context.Context, req *pubsubpb.DeleteTopicRequest, opts ...gax.CallOption) error

DeleteTopic deletes the topic with the given name. Returns `NOT_FOUND` if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `_deleted-topic_`.

Code:

ctx := context.Background()
c, err := pubsub.NewPublisherClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &pubsubpb.DeleteTopicRequest{
// TODO: Fill request struct fields.
}
err = c.DeleteTopic(ctx, req)
if err != nil {
    // TODO: Handle error.
}

func (*PublisherClient) GetTopic Uses

func (c *PublisherClient) GetTopic(ctx context.Context, req *pubsubpb.GetTopicRequest, opts ...gax.CallOption) (*pubsubpb.Topic, error)

GetTopic gets the configuration of a topic.

Code:

ctx := context.Background()
c, err := pubsub.NewPublisherClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &pubsubpb.GetTopicRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetTopic(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*PublisherClient) ListTopicSubscriptions Uses

func (c *PublisherClient) ListTopicSubscriptions(ctx context.Context, req *pubsubpb.ListTopicSubscriptionsRequest, opts ...gax.CallOption) *StringIterator

ListTopicSubscriptions lists the name of the subscriptions for this topic.

Code:

ctx := context.Background()
c, err := pubsub.NewPublisherClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &pubsubpb.ListTopicSubscriptionsRequest{
// TODO: Fill request struct fields.
}
it := c.ListTopicSubscriptions(ctx, req)
for {
    resp, err := it.Next()
    if err == iterator.Done {
        break
    }
    if err != nil {
        // TODO: Handle error.
    }
    // TODO: Use resp.
    _ = resp
}

func (*PublisherClient) ListTopics Uses

func (c *PublisherClient) ListTopics(ctx context.Context, req *pubsubpb.ListTopicsRequest, opts ...gax.CallOption) *TopicIterator

ListTopics lists matching topics.

Code:

ctx := context.Background()
c, err := pubsub.NewPublisherClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &pubsubpb.ListTopicsRequest{
// TODO: Fill request struct fields.
}
it := c.ListTopics(ctx, req)
for {
    resp, err := it.Next()
    if err == iterator.Done {
        break
    }
    if err != nil {
        // TODO: Handle error.
    }
    // TODO: Use resp.
    _ = resp
}

func (*PublisherClient) Publish Uses

func (c *PublisherClient) Publish(ctx context.Context, req *pubsubpb.PublishRequest, opts ...gax.CallOption) (*pubsubpb.PublishResponse, error)

Publish adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does not exist. The message payload must not be empty; it must contain

either a non-empty data field, or at least one attribute.

Code:

ctx := context.Background()
c, err := pubsub.NewPublisherClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &pubsubpb.PublishRequest{
// TODO: Fill request struct fields.
}
resp, err := c.Publish(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*PublisherClient) SetGoogleClientInfo Uses

func (c *PublisherClient) SetGoogleClientInfo(keyval ...string)

SetGoogleClientInfo sets the name and version of the application in the `x-goog-api-client` header passed on each request. Intended for use by Google-written clients.

func (*PublisherClient) SubscriptionIAM Uses

func (c *PublisherClient) SubscriptionIAM(subscription *pubsubpb.Subscription) *iam.Handle

Code:

ctx := context.Background()
c, err := pubsub.NewPublisherClient(ctx)
if err != nil {
    // TODO: Handle error.
}

subscription := &pubsubpb.Subscription{}
h := c.SubscriptionIAM(subscription)
policy, err := h.Policy(ctx)
if err != nil {
    // TODO: Handle error.
}
//TODO: Use the IAM policy
_ = policy

func (*PublisherClient) TopicIAM Uses

func (c *PublisherClient) TopicIAM(topic *pubsubpb.Topic) *iam.Handle

Code:

ctx := context.Background()
c, err := pubsub.NewPublisherClient(ctx)
if err != nil {
    // TODO: Handle error.
}

topic := &pubsubpb.Topic{}
h := c.TopicIAM(topic)
policy, err := h.Policy(ctx)
if err != nil {
    // TODO: Handle error.
}
//TODO: Use the IAM policy
_ = policy

type SnapshotIterator Uses

type SnapshotIterator struct {

    // InternalFetch is for use by the Google Cloud Libraries only.
    // It is not part of the stable interface of this package.
    //
    // InternalFetch returns results from a single call to the underlying RPC.
    // The number of results is no greater than pageSize.
    // If there are no more results, nextPageToken is empty and err is nil.
    InternalFetch func(pageSize int, pageToken string) (results []*pubsubpb.Snapshot, nextPageToken string, err error)
    // contains filtered or unexported fields
}

SnapshotIterator manages a stream of *pubsubpb.Snapshot.

func (*SnapshotIterator) Next Uses

func (it *SnapshotIterator) Next() (*pubsubpb.Snapshot, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*SnapshotIterator) PageInfo Uses

func (it *SnapshotIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type StringIterator Uses

type StringIterator struct {

    // InternalFetch is for use by the Google Cloud Libraries only.
    // It is not part of the stable interface of this package.
    //
    // InternalFetch returns results from a single call to the underlying RPC.
    // The number of results is no greater than pageSize.
    // If there are no more results, nextPageToken is empty and err is nil.
    InternalFetch func(pageSize int, pageToken string) (results []string, nextPageToken string, err error)
    // contains filtered or unexported fields
}

StringIterator manages a stream of string.

func (*StringIterator) Next Uses

func (it *StringIterator) Next() (string, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*StringIterator) PageInfo Uses

func (it *StringIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type SubscriberCallOptions Uses

type SubscriberCallOptions struct {
    CreateSubscription []gax.CallOption
    GetSubscription    []gax.CallOption
    UpdateSubscription []gax.CallOption
    ListSubscriptions  []gax.CallOption
    DeleteSubscription []gax.CallOption
    ModifyAckDeadline  []gax.CallOption
    Acknowledge        []gax.CallOption
    Pull               []gax.CallOption
    StreamingPull      []gax.CallOption
    ModifyPushConfig   []gax.CallOption
    ListSnapshots      []gax.CallOption
    CreateSnapshot     []gax.CallOption
    DeleteSnapshot     []gax.CallOption
    Seek               []gax.CallOption
}

SubscriberCallOptions contains the retry settings for each method of SubscriberClient.

type SubscriberClient Uses

type SubscriberClient struct {

    // The call options for this service.
    CallOptions *SubscriberCallOptions
    // contains filtered or unexported fields
}

SubscriberClient is a client for interacting with Google Cloud Pub/Sub API.

func NewSubscriberClient Uses

func NewSubscriberClient(ctx context.Context, opts ...option.ClientOption) (*SubscriberClient, error)

NewSubscriberClient creates a new subscriber client.

The service that an application uses to manipulate subscriptions and to consume messages from a subscription via the `Pull` method.

Code:

ctx := context.Background()
c, err := pubsub.NewSubscriberClient(ctx)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use client.
_ = c

func (*SubscriberClient) Acknowledge Uses

func (c *SubscriberClient) Acknowledge(ctx context.Context, req *pubsubpb.AcknowledgeRequest, opts ...gax.CallOption) error

Acknowledge acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages from the subscription.

Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error.

Code:

ctx := context.Background()
c, err := pubsub.NewSubscriberClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &pubsubpb.AcknowledgeRequest{
// TODO: Fill request struct fields.
}
err = c.Acknowledge(ctx, req)
if err != nil {
    // TODO: Handle error.
}

func (*SubscriberClient) Close Uses

func (c *SubscriberClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*SubscriberClient) Connection Uses

func (c *SubscriberClient) Connection() *grpc.ClientConn

Connection returns the client's connection to the API service.

func (*SubscriberClient) CreateSnapshot Uses

func (c *SubscriberClient) CreateSnapshot(ctx context.Context, req *pubsubpb.CreateSnapshotRequest, opts ...gax.CallOption) (*pubsubpb.Snapshot, error)

CreateSnapshot creates a snapshot from the requested subscription. If the snapshot already exists, returns `ALREADY_EXISTS`. If the requested subscription doesn't exist, returns `NOT_FOUND`.

If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription, conforming to the [resource name format](https://cloud.google.com/pubsub/docs/overview#names). The generated name is populated in the returned Snapshot object. Note that for REST API requests, you must specify a name in the request.

Code:

ctx := context.Background()
c, err := pubsub.NewSubscriberClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &pubsubpb.CreateSnapshotRequest{
// TODO: Fill request struct fields.
}
resp, err := c.CreateSnapshot(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*SubscriberClient) CreateSubscription Uses

func (c *SubscriberClient) CreateSubscription(ctx context.Context, req *pubsubpb.Subscription, opts ...gax.CallOption) (*pubsubpb.Subscription, error)

CreateSubscription creates a subscription to a given topic. If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`.

If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic, conforming to the [resource name format](https://cloud.google.com/pubsub/docs/overview#names). The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request.

Code:

ctx := context.Background()
c, err := pubsub.NewSubscriberClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &pubsubpb.Subscription{
// TODO: Fill request struct fields.
}
resp, err := c.CreateSubscription(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*SubscriberClient) DeleteSnapshot Uses

func (c *SubscriberClient) DeleteSnapshot(ctx context.Context, req *pubsubpb.DeleteSnapshotRequest, opts ...gax.CallOption) error

DeleteSnapshot removes an existing snapshot. All messages retained in the snapshot are immediately dropped. After a snapshot is deleted, a new one may be created with the same name, but the new one has no association with the old snapshot or its subscription, unless the same subscription is specified.

Code:

ctx := context.Background()
c, err := pubsub.NewSubscriberClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &pubsubpb.DeleteSnapshotRequest{
// TODO: Fill request struct fields.
}
err = c.DeleteSnapshot(ctx, req)
if err != nil {
    // TODO: Handle error.
}

func (*SubscriberClient) DeleteSubscription Uses

func (c *SubscriberClient) DeleteSubscription(ctx context.Context, req *pubsubpb.DeleteSubscriptionRequest, opts ...gax.CallOption) error

DeleteSubscription deletes an existing subscription. All messages retained in the subscription are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription or its topic unless the same topic is specified.

Code:

ctx := context.Background()
c, err := pubsub.NewSubscriberClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &pubsubpb.DeleteSubscriptionRequest{
// TODO: Fill request struct fields.
}
err = c.DeleteSubscription(ctx, req)
if err != nil {
    // TODO: Handle error.
}

func (*SubscriberClient) GetSubscription Uses

func (c *SubscriberClient) GetSubscription(ctx context.Context, req *pubsubpb.GetSubscriptionRequest, opts ...gax.CallOption) (*pubsubpb.Subscription, error)

GetSubscription gets the configuration details of a subscription.

Code:

ctx := context.Background()
c, err := pubsub.NewSubscriberClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &pubsubpb.GetSubscriptionRequest{
// TODO: Fill request struct fields.
}
resp, err := c.GetSubscription(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*SubscriberClient) ListSnapshots Uses

func (c *SubscriberClient) ListSnapshots(ctx context.Context, req *pubsubpb.ListSnapshotsRequest, opts ...gax.CallOption) *SnapshotIterator

ListSnapshots lists the existing snapshots.

Code:

ctx := context.Background()
c, err := pubsub.NewSubscriberClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &pubsubpb.ListSnapshotsRequest{
// TODO: Fill request struct fields.
}
it := c.ListSnapshots(ctx, req)
for {
    resp, err := it.Next()
    if err == iterator.Done {
        break
    }
    if err != nil {
        // TODO: Handle error.
    }
    // TODO: Use resp.
    _ = resp
}

func (*SubscriberClient) ListSubscriptions Uses

func (c *SubscriberClient) ListSubscriptions(ctx context.Context, req *pubsubpb.ListSubscriptionsRequest, opts ...gax.CallOption) *SubscriptionIterator

ListSubscriptions lists matching subscriptions.

Code:

ctx := context.Background()
c, err := pubsub.NewSubscriberClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &pubsubpb.ListSubscriptionsRequest{
// TODO: Fill request struct fields.
}
it := c.ListSubscriptions(ctx, req)
for {
    resp, err := it.Next()
    if err == iterator.Done {
        break
    }
    if err != nil {
        // TODO: Handle error.
    }
    // TODO: Use resp.
    _ = resp
}

func (*SubscriberClient) ModifyAckDeadline Uses

func (c *SubscriberClient) ModifyAckDeadline(ctx context.Context, req *pubsubpb.ModifyAckDeadlineRequest, opts ...gax.CallOption) error

ModifyAckDeadline modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. Note that this does not modify the subscription-level `ackDeadlineSeconds` used for subsequent messages.

Code:

ctx := context.Background()
c, err := pubsub.NewSubscriberClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &pubsubpb.ModifyAckDeadlineRequest{
// TODO: Fill request struct fields.
}
err = c.ModifyAckDeadline(ctx, req)
if err != nil {
    // TODO: Handle error.
}

func (*SubscriberClient) ModifyPushConfig Uses

func (c *SubscriberClient) ModifyPushConfig(ctx context.Context, req *pubsubpb.ModifyPushConfigRequest, opts ...gax.CallOption) error

ModifyPushConfig modifies the `PushConfig` for a specified subscription.

This may be used to change a push subscription to a pull one (signified by an empty `PushConfig`) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the `PushConfig`.

Code:

ctx := context.Background()
c, err := pubsub.NewSubscriberClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &pubsubpb.ModifyPushConfigRequest{
// TODO: Fill request struct fields.
}
err = c.ModifyPushConfig(ctx, req)
if err != nil {
    // TODO: Handle error.
}

func (*SubscriberClient) Pull Uses

func (c *SubscriberClient) Pull(ctx context.Context, req *pubsubpb.PullRequest, opts ...gax.CallOption) (*pubsubpb.PullResponse, error)

Pull pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The server may return `UNAVAILABLE` if there are too many concurrent pull requests pending for the given subscription.

Code:

ctx := context.Background()
c, err := pubsub.NewSubscriberClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &pubsubpb.PullRequest{
// TODO: Fill request struct fields.
}
resp, err := c.Pull(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*SubscriberClient) Seek Uses

func (c *SubscriberClient) Seek(ctx context.Context, req *pubsubpb.SeekRequest, opts ...gax.CallOption) (*pubsubpb.SeekResponse, error)

Seek seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request.

Code:

ctx := context.Background()
c, err := pubsub.NewSubscriberClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &pubsubpb.SeekRequest{
// TODO: Fill request struct fields.
}
resp, err := c.Seek(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*SubscriberClient) SetGoogleClientInfo Uses

func (c *SubscriberClient) SetGoogleClientInfo(keyval ...string)

SetGoogleClientInfo sets the name and version of the application in the `x-goog-api-client` header passed on each request. Intended for use by Google-written clients.

func (*SubscriberClient) StreamingPull Uses

func (c *SubscriberClient) StreamingPull(ctx context.Context, opts ...gax.CallOption) (pubsubpb.Subscriber_StreamingPullClient, error)

StreamingPull (EXPERIMENTAL) StreamingPull is an experimental feature. This RPC will respond with UNIMPLEMENTED errors unless you have been invited to test this feature. Contact cloud-pubsub@google.com with any questions.

Establishes a stream with the server, which sends messages down to the client. The client streams acknowledgements and ack deadline modifications back to the server. The server will close the stream and return the status on any error. The server may close the stream with status `OK` to reassign server-side resources, in which case, the client should re-establish the stream. `UNAVAILABLE` may also be returned in the case of a transient error (e.g., a server restart). These should also be retried by the client. Flow control can be achieved by configuring the underlying RPC channel.

Code:

ctx := context.Background()
c, err := pubsub.NewSubscriberClient(ctx)
if err != nil {
    // TODO: Handle error.
}
stream, err := c.StreamingPull(ctx)
if err != nil {
    // TODO: Handle error.
}
go func() {
    reqs := []*pubsubpb.StreamingPullRequest{
    // TODO: Create requests.
    }
    for _, req := range reqs {
        if err := stream.Send(req); err != nil {
            // TODO: Handle error.
        }
    }
    stream.CloseSend()
}()
for {
    resp, err := stream.Recv()
    if err == io.EOF {
        break
    }
    if err != nil {
        // TODO: handle error.
    }
    // TODO: Use resp.
    _ = resp
}

func (*SubscriberClient) SubscriptionIAM Uses

func (c *SubscriberClient) SubscriptionIAM(subscription *pubsubpb.Subscription) *iam.Handle

Code:

ctx := context.Background()
c, err := pubsub.NewSubscriberClient(ctx)
if err != nil {
    // TODO: Handle error.
}

subscription := &pubsubpb.Subscription{}
h := c.SubscriptionIAM(subscription)
policy, err := h.Policy(ctx)
if err != nil {
    // TODO: Handle error.
}
//TODO: Use the IAM policy
_ = policy

func (*SubscriberClient) TopicIAM Uses

func (c *SubscriberClient) TopicIAM(topic *pubsubpb.Topic) *iam.Handle

Code:

ctx := context.Background()
c, err := pubsub.NewSubscriberClient(ctx)
if err != nil {
    // TODO: Handle error.
}

topic := &pubsubpb.Topic{}
h := c.TopicIAM(topic)
policy, err := h.Policy(ctx)
if err != nil {
    // TODO: Handle error.
}
//TODO: Use the IAM policy
_ = policy

func (*SubscriberClient) UpdateSubscription Uses

func (c *SubscriberClient) UpdateSubscription(ctx context.Context, req *pubsubpb.UpdateSubscriptionRequest, opts ...gax.CallOption) (*pubsubpb.Subscription, error)

UpdateSubscription updates an existing subscription. Note that certain properties of a subscription, such as its topic, are not modifiable.

Code:

ctx := context.Background()
c, err := pubsub.NewSubscriberClient(ctx)
if err != nil {
    // TODO: Handle error.
}

req := &pubsubpb.UpdateSubscriptionRequest{
// TODO: Fill request struct fields.
}
resp, err := c.UpdateSubscription(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

type SubscriptionIterator Uses

type SubscriptionIterator struct {

    // InternalFetch is for use by the Google Cloud Libraries only.
    // It is not part of the stable interface of this package.
    //
    // InternalFetch returns results from a single call to the underlying RPC.
    // The number of results is no greater than pageSize.
    // If there are no more results, nextPageToken is empty and err is nil.
    InternalFetch func(pageSize int, pageToken string) (results []*pubsubpb.Subscription, nextPageToken string, err error)
    // contains filtered or unexported fields
}

SubscriptionIterator manages a stream of *pubsubpb.Subscription.

func (*SubscriptionIterator) Next Uses

func (it *SubscriptionIterator) Next() (*pubsubpb.Subscription, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*SubscriptionIterator) PageInfo Uses

func (it *SubscriptionIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type TopicIterator Uses

type TopicIterator struct {

    // InternalFetch is for use by the Google Cloud Libraries only.
    // It is not part of the stable interface of this package.
    //
    // InternalFetch returns results from a single call to the underlying RPC.
    // The number of results is no greater than pageSize.
    // If there are no more results, nextPageToken is empty and err is nil.
    InternalFetch func(pageSize int, pageToken string) (results []*pubsubpb.Topic, nextPageToken string, err error)
    // contains filtered or unexported fields
}

TopicIterator manages a stream of *pubsubpb.Topic.

func (*TopicIterator) Next Uses

func (it *TopicIterator) Next() (*pubsubpb.Topic, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*TopicIterator) PageInfo Uses

func (it *TopicIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

Package pubsub imports 13 packages (graph) and is imported by 1 packages. Updated 2017-07-21. Refresh now. Tools for package owners.