Documentation ¶
Overview ¶
Package pubsub provides access to the Cloud Pub/Sub API.
This package is DEPRECATED. Use package cloud.google.com/go/pubsub instead.
For product documentation, see: https://cloud.google.com/pubsub/docs
Creating a client ¶
Usage example:
import "google.golang.org/api/pubsub/v1beta1a" ... ctx := context.Background() pubsubService, err := pubsub.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 ¶
By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use option.WithScopes:
pubsubService, err := pubsub.NewService(ctx, option.WithScopes(pubsub.PubsubScope))
To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:
pubsubService, err := pubsub.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, ...) pubsubService, err := pubsub.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
See https://godoc.org/google.golang.org/api/option/ for details on options.
Index ¶
- Constants
- type AcknowledgeRequest
- type Empty
- type Label
- type ListSubscriptionsResponse
- type ListTopicsResponse
- type ModifyAckDeadlineRequest
- type ModifyPushConfigRequest
- type PublishBatchRequest
- type PublishBatchResponse
- type PublishRequest
- type PubsubEvent
- type PubsubMessage
- type PullBatchRequest
- type PullBatchResponse
- type PullRequest
- type PullResponse
- type PushConfig
- type Service
- type Subscription
- type SubscriptionsAcknowledgeCall
- func (c *SubscriptionsAcknowledgeCall) Context(ctx context.Context) *SubscriptionsAcknowledgeCall
- func (c *SubscriptionsAcknowledgeCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *SubscriptionsAcknowledgeCall) Fields(s ...googleapi.Field) *SubscriptionsAcknowledgeCall
- func (c *SubscriptionsAcknowledgeCall) Header() http.Header
- type SubscriptionsCreateCall
- func (c *SubscriptionsCreateCall) Context(ctx context.Context) *SubscriptionsCreateCall
- func (c *SubscriptionsCreateCall) Do(opts ...googleapi.CallOption) (*Subscription, error)
- func (c *SubscriptionsCreateCall) Fields(s ...googleapi.Field) *SubscriptionsCreateCall
- func (c *SubscriptionsCreateCall) Header() http.Header
- type SubscriptionsDeleteCall
- func (c *SubscriptionsDeleteCall) Context(ctx context.Context) *SubscriptionsDeleteCall
- func (c *SubscriptionsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *SubscriptionsDeleteCall) Fields(s ...googleapi.Field) *SubscriptionsDeleteCall
- func (c *SubscriptionsDeleteCall) Header() http.Header
- type SubscriptionsGetCall
- func (c *SubscriptionsGetCall) Context(ctx context.Context) *SubscriptionsGetCall
- func (c *SubscriptionsGetCall) Do(opts ...googleapi.CallOption) (*Subscription, error)
- func (c *SubscriptionsGetCall) Fields(s ...googleapi.Field) *SubscriptionsGetCall
- func (c *SubscriptionsGetCall) Header() http.Header
- func (c *SubscriptionsGetCall) IfNoneMatch(entityTag string) *SubscriptionsGetCall
- type SubscriptionsListCall
- func (c *SubscriptionsListCall) Context(ctx context.Context) *SubscriptionsListCall
- func (c *SubscriptionsListCall) Do(opts ...googleapi.CallOption) (*ListSubscriptionsResponse, error)
- func (c *SubscriptionsListCall) Fields(s ...googleapi.Field) *SubscriptionsListCall
- func (c *SubscriptionsListCall) Header() http.Header
- func (c *SubscriptionsListCall) IfNoneMatch(entityTag string) *SubscriptionsListCall
- func (c *SubscriptionsListCall) MaxResults(maxResults int64) *SubscriptionsListCall
- func (c *SubscriptionsListCall) PageToken(pageToken string) *SubscriptionsListCall
- func (c *SubscriptionsListCall) Pages(ctx context.Context, f func(*ListSubscriptionsResponse) error) error
- func (c *SubscriptionsListCall) Query(query string) *SubscriptionsListCall
- type SubscriptionsModifyAckDeadlineCall
- func (c *SubscriptionsModifyAckDeadlineCall) Context(ctx context.Context) *SubscriptionsModifyAckDeadlineCall
- func (c *SubscriptionsModifyAckDeadlineCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *SubscriptionsModifyAckDeadlineCall) Fields(s ...googleapi.Field) *SubscriptionsModifyAckDeadlineCall
- func (c *SubscriptionsModifyAckDeadlineCall) Header() http.Header
- type SubscriptionsModifyPushConfigCall
- func (c *SubscriptionsModifyPushConfigCall) Context(ctx context.Context) *SubscriptionsModifyPushConfigCall
- func (c *SubscriptionsModifyPushConfigCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *SubscriptionsModifyPushConfigCall) Fields(s ...googleapi.Field) *SubscriptionsModifyPushConfigCall
- func (c *SubscriptionsModifyPushConfigCall) Header() http.Header
- type SubscriptionsPullBatchCall
- func (c *SubscriptionsPullBatchCall) Context(ctx context.Context) *SubscriptionsPullBatchCall
- func (c *SubscriptionsPullBatchCall) Do(opts ...googleapi.CallOption) (*PullBatchResponse, error)
- func (c *SubscriptionsPullBatchCall) Fields(s ...googleapi.Field) *SubscriptionsPullBatchCall
- func (c *SubscriptionsPullBatchCall) Header() http.Header
- type SubscriptionsPullCall
- func (c *SubscriptionsPullCall) Context(ctx context.Context) *SubscriptionsPullCall
- func (c *SubscriptionsPullCall) Do(opts ...googleapi.CallOption) (*PullResponse, error)
- func (c *SubscriptionsPullCall) Fields(s ...googleapi.Field) *SubscriptionsPullCall
- func (c *SubscriptionsPullCall) Header() http.Header
- type SubscriptionsService
- func (r *SubscriptionsService) Acknowledge(acknowledgerequest *AcknowledgeRequest) *SubscriptionsAcknowledgeCall
- func (r *SubscriptionsService) Create(subscription *Subscription) *SubscriptionsCreateCall
- func (r *SubscriptionsService) Delete(subscription string) *SubscriptionsDeleteCall
- func (r *SubscriptionsService) Get(subscription string) *SubscriptionsGetCall
- func (r *SubscriptionsService) List() *SubscriptionsListCall
- func (r *SubscriptionsService) ModifyAckDeadline(modifyackdeadlinerequest *ModifyAckDeadlineRequest) *SubscriptionsModifyAckDeadlineCall
- func (r *SubscriptionsService) ModifyPushConfig(modifypushconfigrequest *ModifyPushConfigRequest) *SubscriptionsModifyPushConfigCall
- func (r *SubscriptionsService) Pull(pullrequest *PullRequest) *SubscriptionsPullCall
- func (r *SubscriptionsService) PullBatch(pullbatchrequest *PullBatchRequest) *SubscriptionsPullBatchCall
- type Topic
- type TopicsCreateCall
- type TopicsDeleteCall
- type TopicsGetCall
- func (c *TopicsGetCall) Context(ctx context.Context) *TopicsGetCall
- func (c *TopicsGetCall) Do(opts ...googleapi.CallOption) (*Topic, error)
- func (c *TopicsGetCall) Fields(s ...googleapi.Field) *TopicsGetCall
- func (c *TopicsGetCall) Header() http.Header
- func (c *TopicsGetCall) IfNoneMatch(entityTag string) *TopicsGetCall
- type TopicsListCall
- func (c *TopicsListCall) Context(ctx context.Context) *TopicsListCall
- func (c *TopicsListCall) Do(opts ...googleapi.CallOption) (*ListTopicsResponse, error)
- func (c *TopicsListCall) Fields(s ...googleapi.Field) *TopicsListCall
- func (c *TopicsListCall) Header() http.Header
- func (c *TopicsListCall) IfNoneMatch(entityTag string) *TopicsListCall
- func (c *TopicsListCall) MaxResults(maxResults int64) *TopicsListCall
- func (c *TopicsListCall) PageToken(pageToken string) *TopicsListCall
- func (c *TopicsListCall) Pages(ctx context.Context, f func(*ListTopicsResponse) error) error
- func (c *TopicsListCall) Query(query string) *TopicsListCall
- type TopicsPublishBatchCall
- func (c *TopicsPublishBatchCall) Context(ctx context.Context) *TopicsPublishBatchCall
- func (c *TopicsPublishBatchCall) Do(opts ...googleapi.CallOption) (*PublishBatchResponse, error)
- func (c *TopicsPublishBatchCall) Fields(s ...googleapi.Field) *TopicsPublishBatchCall
- func (c *TopicsPublishBatchCall) Header() http.Header
- type TopicsPublishCall
- type TopicsService
- func (r *TopicsService) Create(topic *Topic) *TopicsCreateCall
- func (r *TopicsService) Delete(topic string) *TopicsDeleteCall
- func (r *TopicsService) Get(topic string) *TopicsGetCall
- func (r *TopicsService) List() *TopicsListCall
- func (r *TopicsService) Publish(publishrequest *PublishRequest) *TopicsPublishCall
- func (r *TopicsService) PublishBatch(publishbatchrequest *PublishBatchRequest) *TopicsPublishBatchCall
Constants ¶
const ( // View and manage your data across Google Cloud Platform services CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform" // View and manage Pub/Sub topics and subscriptions PubsubScope = "https://www.googleapis.com/auth/pubsub" )
OAuth2 scopes used by this API.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AcknowledgeRequest ¶
type AcknowledgeRequest struct { // AckId: The acknowledgment ID for the message being acknowledged. This // was // returned by the Pub/Sub system in the Pull response. AckId []string `json:"ackId,omitempty"` // Subscription: The subscription whose message is being acknowledged. Subscription string `json:"subscription,omitempty"` // ForceSendFields is a list of field names (e.g. "AckId") to // unconditionally include in API requests. By default, fields with // empty 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. "AckId") 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:"-"` }
AcknowledgeRequest: Request for the Acknowledge method.
func (*AcknowledgeRequest) MarshalJSON ¶
func (s *AcknowledgeRequest) MarshalJSON() ([]byte, error)
type Empty ¶
type Empty struct { // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` }
Empty: An empty message that you can re-use to avoid defining duplicated empty messages in your project. A typical example is to use it as argument or the return value of a service API. For instance:
service Foo { rpc Bar (proto2.Empty) returns (proto2.Empty) { }; };
BEGIN GOOGLE-INTERNAL The difference between this one and net/rpc/empty-message.proto is that
- The generated message here is in proto2 C++ API.
- The proto2.Empty has minimum dependencies (no message_set or net/rpc dependencies)
END GOOGLE-INTERNAL
type Label ¶
type Label struct { // Key: The key of a label is a syntactically valid URL (as per RFC // 1738) with // the "scheme" and initial slashes omitted and with the // additional // restrictions noted below. Each key should be globally unique. // The // "host" portion is called the "namespace" and is not // necessarily // resolvable to a network endpoint. Instead, the namespace indicates // what // system or entity defines the semantics of the label. Namespaces do // not // restrict the set of objects to which a label may be associated. // // Keys are defined by the following grammar: // // key = hostname "/" kpath // kpath = ksegment *[ "/" ksegment ] // ksegment = alphadigit | *[ alphadigit | "-" | "_" | "." // ] // // where "hostname" and "alphadigit" are defined as in RFC // 1738. // // Example key: // spanner.google.com/universe Key string `json:"key,omitempty"` // NumValue: An integer value. NumValue int64 `json:"numValue,omitempty,string"` // StrValue: A string value. StrValue string `json:"strValue,omitempty"` // ForceSendFields is a list of field names (e.g. "Key") to // unconditionally include in API requests. By default, fields with // empty 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. "Key") 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:"-"` }
Label: A key-value pair applied to a given object.
func (*Label) MarshalJSON ¶
type ListSubscriptionsResponse ¶
type ListSubscriptionsResponse struct { // NextPageToken: If not empty, indicates that there are more // subscriptions that match the // request and this value should be passed to the // next // <code>ListSubscriptionsRequest</code> to continue. NextPageToken string `json:"nextPageToken,omitempty"` // Subscription: The subscriptions that match the request. Subscription []*Subscription `json:"subscription,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 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 the ListSubscriptions method.
func (*ListSubscriptionsResponse) MarshalJSON ¶
func (s *ListSubscriptionsResponse) MarshalJSON() ([]byte, error)
type ListTopicsResponse ¶
type ListTopicsResponse struct { // NextPageToken: If not empty, indicates that there are more topics // that match the request, // and this value should be passed to the next // <code>ListTopicsRequest</code> // to continue. NextPageToken string `json:"nextPageToken,omitempty"` // Topic: The resulting topics. Topic []*Topic `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. "NextPageToken") to // unconditionally include in API requests. By default, fields with // empty 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 the ListTopics method.
func (*ListTopicsResponse) MarshalJSON ¶
func (s *ListTopicsResponse) MarshalJSON() ([]byte, error)
type ModifyAckDeadlineRequest ¶
type ModifyAckDeadlineRequest struct { // AckDeadlineSeconds: The new ack deadline with respect to the time // this request was sent to the // Pub/Sub system. Must be >= 0. For example, if the value is 10, the // new ack // deadline will expire 10 seconds after the ModifyAckDeadline call was // made. // Specifying zero may immediately make the message available for // another pull // request. AckDeadlineSeconds int64 `json:"ackDeadlineSeconds,omitempty"` // AckId: The acknowledgment ID. Either this or ack_ids must be // populated, // not both. AckId string `json:"ackId,omitempty"` // AckIds: List of acknowledgment IDs. Either this field or // ack_id // should be populated, not both. AckIds []string `json:"ackIds,omitempty"` // Subscription: Next Index: 5 // The name of the subscription from which messages are being pulled. Subscription string `json:"subscription,omitempty"` // ForceSendFields is a list of field names (e.g. "AckDeadlineSeconds") // to unconditionally include in API requests. By default, fields with // empty 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. "AckDeadlineSeconds") 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:"-"` }
ModifyAckDeadlineRequest: Request for the ModifyAckDeadline method.
func (*ModifyAckDeadlineRequest) MarshalJSON ¶
func (s *ModifyAckDeadlineRequest) MarshalJSON() ([]byte, error)
type ModifyPushConfigRequest ¶
type ModifyPushConfigRequest struct { // PushConfig: An empty <code>push_config</code> indicates that the // Pub/Sub system should // pause pushing messages from the given subscription. PushConfig *PushConfig `json:"pushConfig,omitempty"` // Subscription: The name of the subscription. Subscription string `json:"subscription,omitempty"` // ForceSendFields is a list of field names (e.g. "PushConfig") to // unconditionally include in API requests. By default, fields with // empty 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. "PushConfig") 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:"-"` }
ModifyPushConfigRequest: Request for the ModifyPushConfig method.
func (*ModifyPushConfigRequest) MarshalJSON ¶
func (s *ModifyPushConfigRequest) MarshalJSON() ([]byte, error)
type PublishBatchRequest ¶
type PublishBatchRequest struct { // Messages: The messages to publish. Messages []*PubsubMessage `json:"messages,omitempty"` // Topic: The messages in the request will be published on this topic. Topic string `json:"topic,omitempty"` // ForceSendFields is a list of field names (e.g. "Messages") to // unconditionally include in API requests. By default, fields with // empty 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. "Messages") 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:"-"` }
PublishBatchRequest: Request for the PublishBatch method.
func (*PublishBatchRequest) MarshalJSON ¶
func (s *PublishBatchRequest) MarshalJSON() ([]byte, error)
type PublishBatchResponse ¶
type PublishBatchResponse struct { // MessageIds: The server-assigned ID of each published message, in the // same order as // the messages in the request. IDs are guaranteed to be unique // within // the topic. MessageIds []string `json:"messageIds,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "MessageIds") to // unconditionally include in API requests. By default, fields with // empty 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. "MessageIds") 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:"-"` }
PublishBatchResponse: Response for the PublishBatch method.
func (*PublishBatchResponse) MarshalJSON ¶
func (s *PublishBatchResponse) MarshalJSON() ([]byte, error)
type PublishRequest ¶
type PublishRequest struct { // Message: The message to publish. Message *PubsubMessage `json:"message,omitempty"` // Topic: The message in the request will be published on this topic. Topic string `json:"topic,omitempty"` // ForceSendFields is a list of field names (e.g. "Message") to // unconditionally include in API requests. By default, fields with // empty 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. "Message") 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:"-"` }
PublishRequest: Request for the Publish method.
func (*PublishRequest) MarshalJSON ¶
func (s *PublishRequest) MarshalJSON() ([]byte, error)
type PubsubEvent ¶
type PubsubEvent struct { // Deleted: Indicates that this subscription has been deleted. (Note // that pull // subscribers will always receive NOT_FOUND in response in their // pull // request on the subscription, rather than seeing this boolean.) Deleted bool `json:"deleted,omitempty"` // Message: A received message. Message *PubsubMessage `json:"message,omitempty"` // Subscription: The subscription that received the event. Subscription string `json:"subscription,omitempty"` // Truncated: Indicates that this subscription has been truncated. Truncated bool `json:"truncated,omitempty"` // ForceSendFields is a list of field names (e.g. "Deleted") to // unconditionally include in API requests. By default, fields with // empty 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. "Deleted") 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:"-"` }
PubsubEvent: An event indicating a received message or truncation event.
func (*PubsubEvent) MarshalJSON ¶
func (s *PubsubEvent) MarshalJSON() ([]byte, error)
type PubsubMessage ¶
type PubsubMessage struct { // Data: The message payload. Data string `json:"data,omitempty"` // Label: Optional list of labels for this message. Keys in this // collection must // be unique. Label []*Label `json:"label,omitempty"` // MessageId: ID of this message assigned by the server at publication // time. Guaranteed // to be unique within the topic. This value may be read by a // subscriber // that receives a PubsubMessage via a Pull call or a push delivery. It // must // not be populated by a publisher in a Publish call. MessageId string `json:"messageId,omitempty"` // PublishTime: The time at which the message was published. // The time is milliseconds since the UNIX epoch. PublishTime int64 `json:"publishTime,omitempty,string"` // ForceSendFields is a list of field names (e.g. "Data") to // unconditionally include in API requests. By default, fields with // empty 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. "Data") 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:"-"` }
PubsubMessage: A message data and its labels.
func (*PubsubMessage) MarshalJSON ¶
func (s *PubsubMessage) MarshalJSON() ([]byte, error)
type PullBatchRequest ¶
type PullBatchRequest struct { // MaxEvents: The maximum number of PubsubEvents returned for this // request. The Pub/Sub // system may return fewer than the number of events specified. MaxEvents int64 `json:"maxEvents,omitempty"` // ReturnImmediately: If this is specified as true the system will // respond immediately even if // it is not able to return a message in the Pull response. Otherwise // the // system is allowed to wait until at least one message is available // rather // than returning no messages. The client may cancel the request if it // does // not wish to wait any longer for the response. ReturnImmediately bool `json:"returnImmediately,omitempty"` // Subscription: The subscription from which messages should be pulled. Subscription string `json:"subscription,omitempty"` // ForceSendFields is a list of field names (e.g. "MaxEvents") to // unconditionally include in API requests. By default, fields with // empty 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. "MaxEvents") 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:"-"` }
PullBatchRequest: Request for the PullBatch method.
func (*PullBatchRequest) MarshalJSON ¶
func (s *PullBatchRequest) MarshalJSON() ([]byte, error)
type PullBatchResponse ¶
type PullBatchResponse struct { // PullResponses: Received Pub/Sub messages or status events. The // Pub/Sub system will return // zero messages if there are no more messages available in the backlog. // The // Pub/Sub system may return fewer than the max_events requested even // if // there are more messages available in the backlog. PullResponses []*PullResponse `json:"pullResponses,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "PullResponses") to // unconditionally include in API requests. By default, fields with // empty 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. "PullResponses") 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:"-"` }
PullBatchResponse: Response for the PullBatch method.
func (*PullBatchResponse) MarshalJSON ¶
func (s *PullBatchResponse) MarshalJSON() ([]byte, error)
type PullRequest ¶
type PullRequest struct { // ReturnImmediately: If this is specified as true the system will // respond immediately even if // it is not able to return a message in the Pull response. Otherwise // the // system is allowed to wait until at least one message is available // rather // than returning FAILED_PRECONDITION. The client may cancel the request // if // it does not wish to wait any longer for the response. ReturnImmediately bool `json:"returnImmediately,omitempty"` // Subscription: The subscription from which a message should be pulled. Subscription string `json:"subscription,omitempty"` // ForceSendFields is a list of field names (e.g. "ReturnImmediately") // to unconditionally include in API requests. By default, fields with // empty 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. "ReturnImmediately") 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:"-"` }
PullRequest: Request for the Pull method.
func (*PullRequest) MarshalJSON ¶
func (s *PullRequest) MarshalJSON() ([]byte, error)
type PullResponse ¶
type PullResponse struct { // AckId: This ID must be used to acknowledge the received event or // message. AckId string `json:"ackId,omitempty"` // PubsubEvent: A pubsub message or truncation event. PubsubEvent *PubsubEvent `json:"pubsubEvent,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "AckId") to // unconditionally include in API requests. By default, fields with // empty 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. "AckId") 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:"-"` }
PullResponse: Either a <code>PubsubMessage</code> or a truncation event. One of these two must be populated.
func (*PullResponse) MarshalJSON ¶
func (s *PullResponse) MarshalJSON() ([]byte, error)
type PushConfig ¶
type PushConfig struct { // PushEndpoint: A URL locating the endpoint to which messages should be // pushed. // For example, a Webhook endpoint might use "https://example.com/push". PushEndpoint string `json:"pushEndpoint,omitempty"` // ForceSendFields is a list of field names (e.g. "PushEndpoint") to // unconditionally include in API requests. By default, fields with // empty 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. "PushEndpoint") 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:"-"` }
PushConfig: Configuration for a push delivery endpoint.
func (*PushConfig) MarshalJSON ¶
func (s *PushConfig) MarshalJSON() ([]byte, error)
type Service ¶
type Service struct { BasePath string // API endpoint base URL UserAgent string // optional additional User-Agent fragment Subscriptions *SubscriptionsService Topics *TopicsService // contains filtered or unexported fields }
func New
deprecated
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 ¶
NewService creates a new Service.
type Subscription ¶
type Subscription struct { // AckDeadlineSeconds: For either push or pull delivery, the value is // the maximum time after a // subscriber receives a message before the subscriber should // acknowledge or // Nack the message. If the Ack deadline for a message passes without // an // Ack or a Nack, the Pub/Sub system will eventually redeliver the // message. // If a subscriber acknowledges after the deadline, the Pub/Sub system // may // accept the Ack, but it is possible that the message has been // already // delivered again. Multiple Acks to the message are allowed and // will // succeed. // // For push delivery, this value is used to set the request timeout // for // the call to the push endpoint. // // For pull delivery, this value is used as the initial value for the // Ack // deadline. It may be overridden for each message using its // corresponding // ack_id with <code>ModifyAckDeadline</code>. // While a message is outstanding (i.e. it has been delivered to a // pull // subscriber and the subscriber has not yet Acked or Nacked), the // Pub/Sub // system will not deliver that message to another pull subscriber // (on a best-effort basis). AckDeadlineSeconds int64 `json:"ackDeadlineSeconds,omitempty"` // Name: Name of the subscription. Name string `json:"name,omitempty"` // PushConfig: If push delivery is used with this subscription, this // field is // used to configure it. PushConfig *PushConfig `json:"pushConfig,omitempty"` // Topic: The name of the topic from which this subscription is // receiving messages. 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. "AckDeadlineSeconds") // to unconditionally include in API requests. By default, fields with // empty 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. "AckDeadlineSeconds") 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: A subscription resource.
func (*Subscription) MarshalJSON ¶
func (s *Subscription) MarshalJSON() ([]byte, error)
type SubscriptionsAcknowledgeCall ¶
type SubscriptionsAcknowledgeCall struct {
// contains filtered or unexported fields
}
func (*SubscriptionsAcknowledgeCall) Context ¶
func (c *SubscriptionsAcknowledgeCall) Context(ctx context.Context) *SubscriptionsAcknowledgeCall
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 (*SubscriptionsAcknowledgeCall) Do ¶
func (c *SubscriptionsAcknowledgeCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "pubsub.subscriptions.acknowledge" 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 (*SubscriptionsAcknowledgeCall) Fields ¶
func (c *SubscriptionsAcknowledgeCall) Fields(s ...googleapi.Field) *SubscriptionsAcknowledgeCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*SubscriptionsAcknowledgeCall) Header ¶
func (c *SubscriptionsAcknowledgeCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type SubscriptionsCreateCall ¶
type SubscriptionsCreateCall struct {
// contains filtered or unexported fields
}
func (*SubscriptionsCreateCall) Context ¶
func (c *SubscriptionsCreateCall) Context(ctx context.Context) *SubscriptionsCreateCall
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 (*SubscriptionsCreateCall) Do ¶
func (c *SubscriptionsCreateCall) Do(opts ...googleapi.CallOption) (*Subscription, error)
Do executes the "pubsub.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 (*SubscriptionsCreateCall) Fields ¶
func (c *SubscriptionsCreateCall) Fields(s ...googleapi.Field) *SubscriptionsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*SubscriptionsCreateCall) Header ¶
func (c *SubscriptionsCreateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type SubscriptionsDeleteCall ¶
type SubscriptionsDeleteCall struct {
// contains filtered or unexported fields
}
func (*SubscriptionsDeleteCall) Context ¶
func (c *SubscriptionsDeleteCall) Context(ctx context.Context) *SubscriptionsDeleteCall
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 (*SubscriptionsDeleteCall) Do ¶
func (c *SubscriptionsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "pubsub.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 (*SubscriptionsDeleteCall) Fields ¶
func (c *SubscriptionsDeleteCall) Fields(s ...googleapi.Field) *SubscriptionsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*SubscriptionsDeleteCall) Header ¶
func (c *SubscriptionsDeleteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type SubscriptionsGetCall ¶
type SubscriptionsGetCall struct {
// contains filtered or unexported fields
}
func (*SubscriptionsGetCall) Context ¶
func (c *SubscriptionsGetCall) Context(ctx context.Context) *SubscriptionsGetCall
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 (*SubscriptionsGetCall) Do ¶
func (c *SubscriptionsGetCall) Do(opts ...googleapi.CallOption) (*Subscription, error)
Do executes the "pubsub.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 (*SubscriptionsGetCall) Fields ¶
func (c *SubscriptionsGetCall) Fields(s ...googleapi.Field) *SubscriptionsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*SubscriptionsGetCall) Header ¶
func (c *SubscriptionsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*SubscriptionsGetCall) IfNoneMatch ¶
func (c *SubscriptionsGetCall) IfNoneMatch(entityTag string) *SubscriptionsGetCall
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 SubscriptionsListCall ¶
type SubscriptionsListCall struct {
// contains filtered or unexported fields
}
func (*SubscriptionsListCall) Context ¶
func (c *SubscriptionsListCall) Context(ctx context.Context) *SubscriptionsListCall
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 (*SubscriptionsListCall) Do ¶
func (c *SubscriptionsListCall) Do(opts ...googleapi.CallOption) (*ListSubscriptionsResponse, error)
Do executes the "pubsub.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 (*SubscriptionsListCall) Fields ¶
func (c *SubscriptionsListCall) Fields(s ...googleapi.Field) *SubscriptionsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*SubscriptionsListCall) Header ¶
func (c *SubscriptionsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*SubscriptionsListCall) IfNoneMatch ¶
func (c *SubscriptionsListCall) IfNoneMatch(entityTag string) *SubscriptionsListCall
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 (*SubscriptionsListCall) MaxResults ¶
func (c *SubscriptionsListCall) MaxResults(maxResults int64) *SubscriptionsListCall
MaxResults sets the optional parameter "maxResults": Maximum number of subscriptions to return.
func (*SubscriptionsListCall) PageToken ¶
func (c *SubscriptionsListCall) PageToken(pageToken string) *SubscriptionsListCall
PageToken sets the optional parameter "pageToken": The value obtained in the last <code>ListSubscriptionsResponse</code> for continuation.
func (*SubscriptionsListCall) Pages ¶
func (c *SubscriptionsListCall) 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.
func (*SubscriptionsListCall) Query ¶
func (c *SubscriptionsListCall) Query(query string) *SubscriptionsListCall
Query sets the optional parameter "query": A valid label query expression.
type SubscriptionsModifyAckDeadlineCall ¶
type SubscriptionsModifyAckDeadlineCall struct {
// contains filtered or unexported fields
}
func (*SubscriptionsModifyAckDeadlineCall) Context ¶
func (c *SubscriptionsModifyAckDeadlineCall) Context(ctx context.Context) *SubscriptionsModifyAckDeadlineCall
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 (*SubscriptionsModifyAckDeadlineCall) Do ¶
func (c *SubscriptionsModifyAckDeadlineCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "pubsub.subscriptions.modifyAckDeadline" 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 (*SubscriptionsModifyAckDeadlineCall) Fields ¶
func (c *SubscriptionsModifyAckDeadlineCall) Fields(s ...googleapi.Field) *SubscriptionsModifyAckDeadlineCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*SubscriptionsModifyAckDeadlineCall) Header ¶
func (c *SubscriptionsModifyAckDeadlineCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type SubscriptionsModifyPushConfigCall ¶
type SubscriptionsModifyPushConfigCall struct {
// contains filtered or unexported fields
}
func (*SubscriptionsModifyPushConfigCall) Context ¶
func (c *SubscriptionsModifyPushConfigCall) Context(ctx context.Context) *SubscriptionsModifyPushConfigCall
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 (*SubscriptionsModifyPushConfigCall) Do ¶
func (c *SubscriptionsModifyPushConfigCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "pubsub.subscriptions.modifyPushConfig" 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 (*SubscriptionsModifyPushConfigCall) Fields ¶
func (c *SubscriptionsModifyPushConfigCall) Fields(s ...googleapi.Field) *SubscriptionsModifyPushConfigCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*SubscriptionsModifyPushConfigCall) Header ¶
func (c *SubscriptionsModifyPushConfigCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type SubscriptionsPullBatchCall ¶
type SubscriptionsPullBatchCall struct {
// contains filtered or unexported fields
}
func (*SubscriptionsPullBatchCall) Context ¶
func (c *SubscriptionsPullBatchCall) Context(ctx context.Context) *SubscriptionsPullBatchCall
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 (*SubscriptionsPullBatchCall) Do ¶
func (c *SubscriptionsPullBatchCall) Do(opts ...googleapi.CallOption) (*PullBatchResponse, error)
Do executes the "pubsub.subscriptions.pullBatch" call. Exactly one of *PullBatchResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *PullBatchResponse.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 (*SubscriptionsPullBatchCall) Fields ¶
func (c *SubscriptionsPullBatchCall) Fields(s ...googleapi.Field) *SubscriptionsPullBatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*SubscriptionsPullBatchCall) Header ¶
func (c *SubscriptionsPullBatchCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type SubscriptionsPullCall ¶
type SubscriptionsPullCall struct {
// contains filtered or unexported fields
}
func (*SubscriptionsPullCall) Context ¶
func (c *SubscriptionsPullCall) Context(ctx context.Context) *SubscriptionsPullCall
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 (*SubscriptionsPullCall) Do ¶
func (c *SubscriptionsPullCall) Do(opts ...googleapi.CallOption) (*PullResponse, error)
Do executes the "pubsub.subscriptions.pull" call. Exactly one of *PullResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *PullResponse.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 (*SubscriptionsPullCall) Fields ¶
func (c *SubscriptionsPullCall) Fields(s ...googleapi.Field) *SubscriptionsPullCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*SubscriptionsPullCall) Header ¶
func (c *SubscriptionsPullCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type SubscriptionsService ¶
type SubscriptionsService struct {
// contains filtered or unexported fields
}
func NewSubscriptionsService ¶
func NewSubscriptionsService(s *Service) *SubscriptionsService
func (*SubscriptionsService) Acknowledge ¶
func (r *SubscriptionsService) Acknowledge(acknowledgerequest *AcknowledgeRequest) *SubscriptionsAcknowledgeCall
Acknowledge: Acknowledges a particular received message: the Pub/Sub system can remove the given message from the subscription. Acknowledging a message whose Ack deadline has expired may succeed, but the message could have been already redelivered. Acknowledging a message more than once will not result in an error. This is only used for messages received via pull.
func (*SubscriptionsService) Create ¶
func (r *SubscriptionsService) Create(subscription *Subscription) *SubscriptionsCreateCall
Create: Creates a subscription on a given topic for a given subscriber. 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.
func (*SubscriptionsService) Delete ¶
func (r *SubscriptionsService) Delete(subscription string) *SubscriptionsDeleteCall
Delete: Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to Pull after deletion will return NOT_FOUND.
func (*SubscriptionsService) Get ¶
func (r *SubscriptionsService) Get(subscription string) *SubscriptionsGetCall
Get: Gets the configuration details of a subscription.
func (*SubscriptionsService) List ¶
func (r *SubscriptionsService) List() *SubscriptionsListCall
List: Lists matching subscriptions.
func (*SubscriptionsService) ModifyAckDeadline ¶
func (r *SubscriptionsService) ModifyAckDeadline(modifyackdeadlinerequest *ModifyAckDeadlineRequest) *SubscriptionsModifyAckDeadlineCall
ModifyAckDeadline: Modifies the Ack deadline for a message received from a pull request.
func (*SubscriptionsService) ModifyPushConfig ¶
func (r *SubscriptionsService) ModifyPushConfig(modifypushconfigrequest *ModifyPushConfigRequest) *SubscriptionsModifyPushConfigCall
ModifyPushConfig: Modifies the <code>PushConfig</code> for a specified subscription. This method can be used to suspend the flow of messages to an endpoint by clearing the <code>PushConfig</code> field in the request. Messages will be accumulated for delivery even if no push configuration is defined or while the configuration is modified.
func (*SubscriptionsService) Pull ¶
func (r *SubscriptionsService) Pull(pullrequest *PullRequest) *SubscriptionsPullCall
Pull: Pulls a single message from the server. If return_immediately is true, and no messages are available in the subscription, this method returns FAILED_PRECONDITION. The system is free to return an UNAVAILABLE error if no messages are available in a reasonable amount of time (to reduce system load).
func (*SubscriptionsService) PullBatch ¶
func (r *SubscriptionsService) PullBatch(pullbatchrequest *PullBatchRequest) *SubscriptionsPullBatchCall
PullBatch: Pulls messages from the server. Returns an empty list if there are no messages available in the backlog. The system is free to return UNAVAILABLE if there are too many pull requests outstanding for the given subscription.
type Topic ¶
type Topic struct { // Name: Name of the topic. Name string `json:"name,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 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: A topic resource.
func (*Topic) MarshalJSON ¶
type TopicsCreateCall ¶
type TopicsCreateCall struct {
// contains filtered or unexported fields
}
func (*TopicsCreateCall) Context ¶
func (c *TopicsCreateCall) Context(ctx context.Context) *TopicsCreateCall
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 (*TopicsCreateCall) Do ¶
func (c *TopicsCreateCall) Do(opts ...googleapi.CallOption) (*Topic, error)
Do executes the "pubsub.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 (*TopicsCreateCall) Fields ¶
func (c *TopicsCreateCall) Fields(s ...googleapi.Field) *TopicsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*TopicsCreateCall) Header ¶
func (c *TopicsCreateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type TopicsDeleteCall ¶
type TopicsDeleteCall struct {
// contains filtered or unexported fields
}
func (*TopicsDeleteCall) Context ¶
func (c *TopicsDeleteCall) Context(ctx context.Context) *TopicsDeleteCall
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 (*TopicsDeleteCall) Do ¶
func (c *TopicsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "pubsub.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 (*TopicsDeleteCall) Fields ¶
func (c *TopicsDeleteCall) Fields(s ...googleapi.Field) *TopicsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*TopicsDeleteCall) Header ¶
func (c *TopicsDeleteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type TopicsGetCall ¶
type TopicsGetCall struct {
// contains filtered or unexported fields
}
func (*TopicsGetCall) Context ¶
func (c *TopicsGetCall) Context(ctx context.Context) *TopicsGetCall
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 (*TopicsGetCall) Do ¶
func (c *TopicsGetCall) Do(opts ...googleapi.CallOption) (*Topic, error)
Do executes the "pubsub.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 (*TopicsGetCall) Fields ¶
func (c *TopicsGetCall) Fields(s ...googleapi.Field) *TopicsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*TopicsGetCall) Header ¶
func (c *TopicsGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*TopicsGetCall) IfNoneMatch ¶
func (c *TopicsGetCall) IfNoneMatch(entityTag string) *TopicsGetCall
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 TopicsListCall ¶
type TopicsListCall struct {
// contains filtered or unexported fields
}
func (*TopicsListCall) Context ¶
func (c *TopicsListCall) Context(ctx context.Context) *TopicsListCall
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 (*TopicsListCall) Do ¶
func (c *TopicsListCall) Do(opts ...googleapi.CallOption) (*ListTopicsResponse, error)
Do executes the "pubsub.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 (*TopicsListCall) Fields ¶
func (c *TopicsListCall) Fields(s ...googleapi.Field) *TopicsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*TopicsListCall) Header ¶
func (c *TopicsListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*TopicsListCall) IfNoneMatch ¶
func (c *TopicsListCall) IfNoneMatch(entityTag string) *TopicsListCall
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 (*TopicsListCall) MaxResults ¶
func (c *TopicsListCall) MaxResults(maxResults int64) *TopicsListCall
MaxResults sets the optional parameter "maxResults": Maximum number of topics to return.
func (*TopicsListCall) PageToken ¶
func (c *TopicsListCall) PageToken(pageToken string) *TopicsListCall
PageToken sets the optional parameter "pageToken": The value obtained in the last <code>ListTopicsResponse</code> for continuation.
func (*TopicsListCall) Pages ¶
func (c *TopicsListCall) 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.
func (*TopicsListCall) Query ¶
func (c *TopicsListCall) Query(query string) *TopicsListCall
Query sets the optional parameter "query": A valid label query expression.
type TopicsPublishBatchCall ¶
type TopicsPublishBatchCall struct {
// contains filtered or unexported fields
}
func (*TopicsPublishBatchCall) Context ¶
func (c *TopicsPublishBatchCall) Context(ctx context.Context) *TopicsPublishBatchCall
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 (*TopicsPublishBatchCall) Do ¶
func (c *TopicsPublishBatchCall) Do(opts ...googleapi.CallOption) (*PublishBatchResponse, error)
Do executes the "pubsub.topics.publishBatch" call. Exactly one of *PublishBatchResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *PublishBatchResponse.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 (*TopicsPublishBatchCall) Fields ¶
func (c *TopicsPublishBatchCall) Fields(s ...googleapi.Field) *TopicsPublishBatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*TopicsPublishBatchCall) Header ¶
func (c *TopicsPublishBatchCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type TopicsPublishCall ¶
type TopicsPublishCall struct {
// contains filtered or unexported fields
}
func (*TopicsPublishCall) Context ¶
func (c *TopicsPublishCall) Context(ctx context.Context) *TopicsPublishCall
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 (*TopicsPublishCall) Do ¶
func (c *TopicsPublishCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "pubsub.topics.publish" 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 (*TopicsPublishCall) Fields ¶
func (c *TopicsPublishCall) Fields(s ...googleapi.Field) *TopicsPublishCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*TopicsPublishCall) Header ¶
func (c *TopicsPublishCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type TopicsService ¶
type TopicsService struct {
// contains filtered or unexported fields
}
func NewTopicsService ¶
func NewTopicsService(s *Service) *TopicsService
func (*TopicsService) Create ¶
func (r *TopicsService) Create(topic *Topic) *TopicsCreateCall
Create: Creates the given topic with the given name.
func (*TopicsService) Delete ¶
func (r *TopicsService) Delete(topic string) *TopicsDeleteCall
Delete: 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.
func (*TopicsService) Get ¶
func (r *TopicsService) Get(topic string) *TopicsGetCall
Get: Gets the configuration of a topic. Since the topic only has the name attribute, this method is only useful to check the existence of a topic. If other attributes are added in the future, they will be returned here.
func (*TopicsService) List ¶
func (r *TopicsService) List() *TopicsListCall
List: Lists matching topics.
func (*TopicsService) Publish ¶
func (r *TopicsService) Publish(publishrequest *PublishRequest) *TopicsPublishCall
Publish: Adds a message to the topic. Returns NOT_FOUND if the topic does not exist.
func (*TopicsService) PublishBatch ¶
func (r *TopicsService) PublishBatch(publishbatchrequest *PublishBatchRequest) *TopicsPublishBatchCall
PublishBatch: Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist.