pubsub

package
v0.0.0-...-7ca0ba9 Latest Latest
Warning

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

 Go to latest Published: Aug 28, 2015 License: BSD-3-Clause Imports: 11 Imported by: 0

Documentation

Overview

Package pubsub provides access to the Google Cloud Pub/Sub API.

See https://cloud.google.com/pubsub/docs

Usage example: 

import "google.golang.org/api/pubsub/v1beta2"
...
pubsubService, err := pubsub.New(oauthHttpClient)

Index

Constants

View Source 
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 {
	// AckIds: The acknowledgment ID for the messages being acknowledged
	// that was returned by the Pub/Sub system in the Pull response. Must
	// not be empty.
	AckIds []string `json:"ackIds,omitempty"`
}

AcknowledgeRequest: Request for the Acknowledge method.

type Binding 

type Binding struct {
	// Members: Format of member entries: 1. allUsers Matches any requesting
	// principal (users, service accounts or anonymous). 2.
	// allAuthenticatedUsers Matches any requesting authenticated principal
	// (users or service accounts). 3. user:{emailid} A google user account
	// using an email address. For example alice@gmail.com, joe@example.com
	// 4. serviceAccount:{emailid} An service account email. 5.
	// group:{emailid} A google group with an email address. For example
	// auth-ti-cloud@google.com 6. domain:{domain} A Google Apps domain
	// name. For example google.com, example.com
	Members []string `json:"members,omitempty"`

	// Role: The name of the role to which the members should be bound.
	// Examples: "roles/viewer", "roles/editor", "roles/owner". Required
	Role string `json:"role,omitempty"`
}

Binding: Associates members with roles. See below for allowed formats of members.

type Empty 

type Empty struct {
}

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

type ListSubscriptionsResponse 

type ListSubscriptionsResponse struct {
	// NextPageToken: If not empty, indicates that there may be more
	// subscriptions that match the request; this value should be passed in
	// a new ListSubscriptionsRequest to get more subscriptions.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Subscriptions: The subscriptions that match the request.
	Subscriptions []*Subscription `json:"subscriptions,omitempty"`
}

ListSubscriptionsResponse: Response for the ListSubscriptions method.

type ListTopicSubscriptionsResponse 

type ListTopicSubscriptionsResponse struct {
	// NextPageToken: If not empty, indicates that there may be more
	// subscriptions that match the request; this value should be passed in
	// a new ListTopicSubscriptionsRequest to get more subscriptions.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Subscriptions: The names of the subscriptions that match the request.
	Subscriptions []string `json:"subscriptions,omitempty"`
}

ListTopicSubscriptionsResponse: Response for the ListTopicSubscriptions method.

type ListTopicsResponse 

type ListTopicsResponse struct {
	// NextPageToken: If not empty, indicates that there may be more topics
	// that match the request; this value should be passed in a new
	// ListTopicsRequest.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Topics: The resulting topics.
	Topics []*Topic `json:"topics,omitempty"`
}

ListTopicsResponse: Response for the ListTopics method.

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, but not both.
	AckId string `json:"ackId,omitempty"`

	// AckIds: List of acknowledgment IDs.
	AckIds []string `json:"ackIds,omitempty"`
}

ModifyAckDeadlineRequest: Request for the ModifyAckDeadline method.

type ModifyPushConfigRequest 

type ModifyPushConfigRequest struct {
	// PushConfig: The push configuration for future deliveries. An empty
	// pushConfig indicates that the Pub/Sub system should stop pushing
	// messages from the given subscription and allow messages to be pulled
	// and acknowledged - effectively pausing the subscription if Pull is
	// not called.
	PushConfig *PushConfig `json:"pushConfig,omitempty"`
}

ModifyPushConfigRequest: Request for the ModifyPushConfig method.

type Policy 

type Policy struct {
	// Bindings: It is an error to specify multiple bindings for the same
	// role. It is an error to specify a binding with no members.
	Bindings []*Binding `json:"bindings,omitempty"`

	// Etag: Can be used to perform a read-modify-write.
	Etag string `json:"etag,omitempty"`

	// Version: The policy language version. The version of the policy is
	// represented by the etag. The default version is 0.
	Version int64 `json:"version,omitempty"`
}

Policy: # Overview The `Policy` defines an access control policy language. It is used to define policies that are attached to resources like files, folders, VMs, etc. # Policy structure A `Policy` consists of a list of bindings. A `Binding` binds a set of members to a role, where the members include user accounts, user groups, user domains, and service accounts. A 'role' is a named set of permissions, defined by IAM. The definition of a role is outside the policy. A permission check first determines the roles that include the specified permission, and then determines if the principal specified is a member of a binding to at least one of these roles. The membership check is recursive when a group is bound to a role. Policy examples: ``` { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:frontend@example.iam.gserviceaccounts.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } ```

type ProjectsService 

type ProjectsService struct {
	Subscriptions *ProjectsSubscriptionsService

	Topics *ProjectsTopicsService
	// contains filtered or unexported fields
}

func NewProjectsService 

func NewProjectsService(s *Service) *ProjectsService

type ProjectsSubscriptionsAcknowledgeCall 

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

func (*ProjectsSubscriptionsAcknowledgeCall) Do 

func (c *ProjectsSubscriptionsAcknowledgeCall) Do() (*Empty, error)

func (*ProjectsSubscriptionsAcknowledgeCall) Fields 

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

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

type ProjectsSubscriptionsCreateCall 

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

func (*ProjectsSubscriptionsCreateCall) Do 

func (c *ProjectsSubscriptionsCreateCall) Do() (*Subscription, error)

func (*ProjectsSubscriptionsCreateCall) Fields 

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

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

type ProjectsSubscriptionsDeleteCall 

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

func (*ProjectsSubscriptionsDeleteCall) Do 

func (c *ProjectsSubscriptionsDeleteCall) Do() (*Empty, error)

func (*ProjectsSubscriptionsDeleteCall) Fields 

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

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

type ProjectsSubscriptionsGetCall 

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

func (*ProjectsSubscriptionsGetCall) Do 

func (c *ProjectsSubscriptionsGetCall) Do() (*Subscription, error)

func (*ProjectsSubscriptionsGetCall) Fields 

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

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

type ProjectsSubscriptionsGetIamPolicyCall 

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

func (*ProjectsSubscriptionsGetIamPolicyCall) Do 

func (c *ProjectsSubscriptionsGetIamPolicyCall) Do() (*Policy, error)

func (*ProjectsSubscriptionsGetIamPolicyCall) Fields 

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

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

type ProjectsSubscriptionsListCall 

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

func (*ProjectsSubscriptionsListCall) Do 

func (c *ProjectsSubscriptionsListCall) Do() (*ListSubscriptionsResponse, error)

func (*ProjectsSubscriptionsListCall) Fields 

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

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

func (*ProjectsSubscriptionsListCall) PageSize 

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

PageSize sets the optional parameter "pageSize": Maximum number of subscriptions to return.

func (*ProjectsSubscriptionsListCall) PageToken 

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

PageToken sets the optional parameter "pageToken": The value returned by the last ListSubscriptionsResponse; indicates that this is a continuation of a prior ListSubscriptions call, and that the system should return the next page of data.

type ProjectsSubscriptionsModifyAckDeadlineCall 

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

func (*ProjectsSubscriptionsModifyAckDeadlineCall) Do 

func (c *ProjectsSubscriptionsModifyAckDeadlineCall) Do() (*Empty, error)

func (*ProjectsSubscriptionsModifyAckDeadlineCall) Fields 

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

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

type ProjectsSubscriptionsModifyPushConfigCall 

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

func (*ProjectsSubscriptionsModifyPushConfigCall) Do 

func (c *ProjectsSubscriptionsModifyPushConfigCall) Do() (*Empty, error)

func (*ProjectsSubscriptionsModifyPushConfigCall) Fields 

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

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

type ProjectsSubscriptionsPullCall 

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

func (*ProjectsSubscriptionsPullCall) Do 

func (c *ProjectsSubscriptionsPullCall) Do() (*PullResponse, error)

func (*ProjectsSubscriptionsPullCall) Fields 

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

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

type ProjectsSubscriptionsService 

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

func NewProjectsSubscriptionsService 

func NewProjectsSubscriptionsService(s *Service) *ProjectsSubscriptionsService

func (*ProjectsSubscriptionsService) Acknowledge 

func (r *ProjectsSubscriptionsService) Acknowledge(subscription string, acknowledgerequest *AcknowledgeRequest) *ProjectsSubscriptionsAcknowledgeCall

Acknowledge: Acknowledges the messages associated with the ack tokens 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.

func (*ProjectsSubscriptionsService) Create 

func (r *ProjectsSubscriptionsService) Create(name string, subscription *Subscription) *ProjectsSubscriptionsCreateCall

Create: Creates a subscription to 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 (*ProjectsSubscriptionsService) Delete 

func (r *ProjectsSubscriptionsService) Delete(subscription string) *ProjectsSubscriptionsDeleteCall

Delete: Deletes an existing subscription. All pending messages 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.

func (*ProjectsSubscriptionsService) Get 

func (r *ProjectsSubscriptionsService) Get(subscription string) *ProjectsSubscriptionsGetCall

Get: Gets the configuration details of a subscription.

func (*ProjectsSubscriptionsService) GetIamPolicy 

func (r *ProjectsSubscriptionsService) GetIamPolicy(resource string) *ProjectsSubscriptionsGetIamPolicyCall

GetIamPolicy: Gets the access control policy for a resource. Is empty if the policy or the resource does not exist.

func (*ProjectsSubscriptionsService) List 

func (r *ProjectsSubscriptionsService) List(project string) *ProjectsSubscriptionsListCall

List: Lists matching subscriptions.

func (*ProjectsSubscriptionsService) ModifyAckDeadline 

func (r *ProjectsSubscriptionsService) ModifyAckDeadline(subscription string, modifyackdeadlinerequest *ModifyAckDeadlineRequest) *ProjectsSubscriptionsModifyAckDeadlineCall

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.

func (*ProjectsSubscriptionsService) ModifyPushConfig 

func (r *ProjectsSubscriptionsService) ModifyPushConfig(subscription string, modifypushconfigrequest *ModifyPushConfigRequest) *ProjectsSubscriptionsModifyPushConfigCall

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.

func (*ProjectsSubscriptionsService) Pull 

func (r *ProjectsSubscriptionsService) Pull(subscription string, pullrequest *PullRequest) *ProjectsSubscriptionsPullCall

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.

func (*ProjectsSubscriptionsService) SetIamPolicy 

func (r *ProjectsSubscriptionsService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsSubscriptionsSetIamPolicyCall

SetIamPolicy: Sets the access control policy on the specified resource. Replaces any existing policy.

func (*ProjectsSubscriptionsService) TestIamPermissions 

func (r *ProjectsSubscriptionsService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsSubscriptionsTestIamPermissionsCall

TestIamPermissions: Returns permissions that a caller has on the specified resource.

type ProjectsSubscriptionsSetIamPolicyCall 

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

func (*ProjectsSubscriptionsSetIamPolicyCall) Do 

func (c *ProjectsSubscriptionsSetIamPolicyCall) Do() (*Policy, error)

func (*ProjectsSubscriptionsSetIamPolicyCall) Fields 

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

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

type ProjectsSubscriptionsTestIamPermissionsCall 

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

func (*ProjectsSubscriptionsTestIamPermissionsCall) Do 

func (c *ProjectsSubscriptionsTestIamPermissionsCall) Do() (*TestIamPermissionsResponse, error)

func (*ProjectsSubscriptionsTestIamPermissionsCall) Fields 

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

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

type ProjectsTopicsCreateCall 

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

func (*ProjectsTopicsCreateCall) Do 

func (c *ProjectsTopicsCreateCall) Do() (*Topic, error)

func (*ProjectsTopicsCreateCall) Fields 

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

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

type ProjectsTopicsDeleteCall 

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

func (*ProjectsTopicsDeleteCall) Do 

func (c *ProjectsTopicsDeleteCall) Do() (*Empty, error)

func (*ProjectsTopicsDeleteCall) Fields 

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

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

type ProjectsTopicsGetCall 

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

func (*ProjectsTopicsGetCall) Do 

func (c *ProjectsTopicsGetCall) Do() (*Topic, error)

func (*ProjectsTopicsGetCall) Fields 

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

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

type ProjectsTopicsGetIamPolicyCall 

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

func (*ProjectsTopicsGetIamPolicyCall) Do 

func (c *ProjectsTopicsGetIamPolicyCall) Do() (*Policy, error)

func (*ProjectsTopicsGetIamPolicyCall) Fields 

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

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

type ProjectsTopicsListCall 

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

func (*ProjectsTopicsListCall) Do 

func (c *ProjectsTopicsListCall) Do() (*ListTopicsResponse, error)

func (*ProjectsTopicsListCall) Fields 

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

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

func (*ProjectsTopicsListCall) PageSize 

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

PageSize sets the optional parameter "pageSize": Maximum number of topics to return.

func (*ProjectsTopicsListCall) PageToken 

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

PageToken sets the optional parameter "pageToken": The value returned by the last ListTopicsResponse; indicates that this is a continuation of a prior ListTopics call, and that the system should return the next page of data.

type ProjectsTopicsPublishCall 

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

func (*ProjectsTopicsPublishCall) Do 

func (c *ProjectsTopicsPublishCall) Do() (*PublishResponse, error)

func (*ProjectsTopicsPublishCall) Fields 

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

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

type ProjectsTopicsService 

type ProjectsTopicsService struct {
	Subscriptions *ProjectsTopicsSubscriptionsService
	// contains filtered or unexported fields
}

func NewProjectsTopicsService 

func NewProjectsTopicsService(s *Service) *ProjectsTopicsService

func (*ProjectsTopicsService) Create 

func (r *ProjectsTopicsService) Create(name string, topic *Topic) *ProjectsTopicsCreateCall

Create: Creates the given topic with the given name.

func (*ProjectsTopicsService) Delete 

func (r *ProjectsTopicsService) Delete(topic string) *ProjectsTopicsDeleteCall

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; 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_`.

func (*ProjectsTopicsService) Get 

func (r *ProjectsTopicsService) Get(topic string) *ProjectsTopicsGetCall

Get: Gets the configuration of a topic.

func (*ProjectsTopicsService) GetIamPolicy 

func (r *ProjectsTopicsService) GetIamPolicy(resource string) *ProjectsTopicsGetIamPolicyCall

GetIamPolicy: Gets the access control policy for a resource. Is empty if the policy or the resource does not exist.

func (*ProjectsTopicsService) List 

func (r *ProjectsTopicsService) List(project string) *ProjectsTopicsListCall

List: Lists matching topics.

func (*ProjectsTopicsService) Publish 

func (r *ProjectsTopicsService) Publish(topic string, publishrequest *PublishRequest) *ProjectsTopicsPublishCall

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.

func (*ProjectsTopicsService) SetIamPolicy 

func (r *ProjectsTopicsService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsTopicsSetIamPolicyCall

SetIamPolicy: Sets the access control policy on the specified resource. Replaces any existing policy.

func (*ProjectsTopicsService) TestIamPermissions 

func (r *ProjectsTopicsService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsTopicsTestIamPermissionsCall

TestIamPermissions: Returns permissions that a caller has on the specified resource.

type ProjectsTopicsSetIamPolicyCall 

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

func (*ProjectsTopicsSetIamPolicyCall) Do 

func (c *ProjectsTopicsSetIamPolicyCall) Do() (*Policy, error)

func (*ProjectsTopicsSetIamPolicyCall) Fields 

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

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

type ProjectsTopicsSubscriptionsListCall 

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

func (*ProjectsTopicsSubscriptionsListCall) Do 

func (c *ProjectsTopicsSubscriptionsListCall) Do() (*ListTopicSubscriptionsResponse, error)

func (*ProjectsTopicsSubscriptionsListCall) Fields 

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

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

func (*ProjectsTopicsSubscriptionsListCall) PageSize 

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

PageSize sets the optional parameter "pageSize": Maximum number of subscription names to return.

func (*ProjectsTopicsSubscriptionsListCall) PageToken 

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

PageToken sets the optional parameter "pageToken": The value returned by the last ListTopicSubscriptionsResponse; indicates that this is a continuation of a prior ListTopicSubscriptions call, and that the system should return the next page of data.

type ProjectsTopicsSubscriptionsService 

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

func NewProjectsTopicsSubscriptionsService 

func NewProjectsTopicsSubscriptionsService(s *Service) *ProjectsTopicsSubscriptionsService

func (*ProjectsTopicsSubscriptionsService) List 

func (r *ProjectsTopicsSubscriptionsService) List(topic string) *ProjectsTopicsSubscriptionsListCall

List: Lists the name of the subscriptions for this topic.

type ProjectsTopicsTestIamPermissionsCall 

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

func (*ProjectsTopicsTestIamPermissionsCall) Do 

func (c *ProjectsTopicsTestIamPermissionsCall) Do() (*TestIamPermissionsResponse, error)

func (*ProjectsTopicsTestIamPermissionsCall) Fields 

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

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

type PublishRequest 

type PublishRequest struct {
	// Messages: The messages to publish.
	Messages []*PubsubMessage `json:"messages,omitempty"`
}

PublishRequest: Request for the Publish method.

type PublishResponse 

type PublishResponse 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"`
}

PublishResponse: Response for the Publish method.

type PubsubMessage 

type PubsubMessage struct {
	// Attributes: Optional attributes for this message.
	Attributes map[string]string `json:"attributes,omitempty"`

	// Data: The message payload. For JSON requests, the value of this field
	// must be base64-encoded.
	Data string `json:"data,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"`
}

PubsubMessage: A message data and its attributes. The message payload must not be empty; it must contain either a non-empty data field, or at least one attribute.

type PullRequest 

type PullRequest struct {
	// MaxMessages: The maximum number of messages returned for this
	// request. The Pub/Sub system may return fewer than the number
	// specified.
	MaxMessages int64 `json:"maxMessages,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"`
}

PullRequest: Request for the Pull method.

type PullResponse 

type PullResponse struct {
	// ReceivedMessages: Received Pub/Sub messages. The Pub/Sub system will
	// return zero messages if there are no more available in the backlog.
	// The Pub/Sub system may return fewer than the maxMessages requested
	// even if there are more messages available in the backlog.
	ReceivedMessages []*ReceivedMessage `json:"receivedMessages,omitempty"`
}

PullResponse: Response for the Pull method.

type PushConfig 

type PushConfig struct {
	// Attributes: Endpoint configuration attributes. Every endpoint has a
	// set of API supported attributes that can be used to control different
	// aspects of the message delivery. The currently supported attribute is
	// `x-goog-version`, which you can use to change the format of the push
	// message. This attribute indicates the version of the data expected by
	// the endpoint. This controls the shape of the envelope (i.e. its
	// fields and metadata). The endpoint version is based on the version of
	// the Pub/Sub API. If not present during the CreateSubscription call,
	// it will default to the version of the API used to make such call. If
	// not present during a ModifyPushConfig call, its value will not be
	// changed. GetSubscription calls will always return a valid version,
	// even if the subscription was created without this attribute. The
	// possible values for this attribute are: * `v1beta1`: uses the push
	// format defined in the v1beta1 Pub/Sub API. * `v1` or `v1beta2`: uses
	// the push format defined in the v1 Pub/Sub API.
	Attributes map[string]string `json:"attributes,omitempty"`

	// 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"`
}

PushConfig: Configuration for a push delivery endpoint.

type ReceivedMessage 

type ReceivedMessage struct {
	// AckId: This ID can be used to acknowledge the received message.
	AckId string `json:"ackId,omitempty"`

	// Message: The message.
	Message *PubsubMessage `json:"message,omitempty"`
}

ReceivedMessage: A message and its corresponding acknowledgment ID.

type Service 

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

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New 

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

type SetIamPolicyRequest 

type SetIamPolicyRequest struct {
	// Policy: REQUIRED: The complete policy to be applied to the
	// 'resource'. The size of the policy is limited to a few 10s of KB. An
	// empty policy is in general a valid policy but certain services (like
	// Projects) might reject them.
	Policy *Policy `json:"policy,omitempty"`
}

SetIamPolicyRequest: Request message for `SetIamPolicy` method.

type Subscription 

type Subscription struct {
	// AckDeadlineSeconds: This value is the maximum time after a subscriber
	// receives a message before the subscriber should acknowledge the
	// message. After message delivery but before the ack deadline expires
	// and before the message is acknowledged, it is an outstanding message
	// and will not be delivered again during that time (on a best-effort
	// basis). For pull delivery this value is used as the initial value for
	// the ack deadline. To override this value for a given message, call
	// ModifyAckDeadline with the corresponding ack_id. For push delivery,
	// this value is also used to set the request timeout for the call to
	// the push endpoint. If the subscriber never acknowledges the message,
	// the Pub/Sub system will eventually redeliver the message. If this
	// parameter is not set, the default value of 10 seconds is used.
	AckDeadlineSeconds int64 `json:"ackDeadlineSeconds,omitempty"`

	// Name: The name of the subscription. It must have the format
	// "projects/{project}/subscriptions/{subscription}". `{subscription}`
	// must start with a letter, and contain only letters (`[A-Za-z]`),
	// numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`),
	// tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3
	// and 255 characters in length, and it must not start with "goog".
	Name string `json:"name,omitempty"`

	// PushConfig: If push delivery is used with this subscription, this
	// field is used to configure it. An empty pushConfig signifies that the
	// subscriber will pull and ack messages using API methods.
	PushConfig *PushConfig `json:"pushConfig,omitempty"`

	// Topic: The name of the topic from which this subscription is
	// receiving messages. The value of this field will be `_deleted-topic_`
	// if the topic has been deleted.
	Topic string `json:"topic,omitempty"`
}

Subscription: A subscription resource.

type TestIamPermissionsRequest 

type TestIamPermissionsRequest struct {
	// Permissions: The set of permissions to check for the 'resource'.
	// Permissions with wildcards (such as '*' or 'storage.*') are not
	// allowed.
	Permissions []string `json:"permissions,omitempty"`
}

TestIamPermissionsRequest: Request message for `TestIamPermissions` method.

type TestIamPermissionsResponse 

type TestIamPermissionsResponse struct {
	// Permissions: A subset of `TestPermissionsRequest.permissions` that
	// the caller is allowed.
	Permissions []string `json:"permissions,omitempty"`
}

TestIamPermissionsResponse: Response message for `TestIamPermissions` method.

type Topic 

type Topic struct {
	// Name: The name of the topic. It must have the format
	// "projects/{project}/topics/{topic}". `{topic}` must start with a
	// letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`),
	// dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus
	// (`+`) or percent signs (`%`). It must be between 3 and 255 characters
	// in length, and it must not start with "goog".
	Name string `json:"name,omitempty"`
}

Topic: A topic resource.

Source Files

View all Source files

Jump to

Keyboard shortcuts

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