api: google.golang.org/api/pubsub/v1 Index | Files

package pubsub

import "google.golang.org/api/pubsub/v1"

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/v1"
...
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

Package Files

pubsub-gen.go

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.

type AcknowledgeRequest Uses

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

    // ForceSendFields is a list of field names (e.g. "AckIds") 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. "AckIds") 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 Uses

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

type Binding Uses

type Binding struct {
    // Condition: The condition that is associated with this binding.
    // NOTE: An unsatisfied condition will not allow user access via
    // current
    // binding. Different bindings, including their conditions, are
    // examined
    // independently.
    Condition *Expr `json:"condition,omitempty"`

    // Members: Specifies the identities requesting access for a Cloud
    // Platform resource.
    // `members` can have the following values:
    //
    // * `allUsers`: A special identifier that represents anyone who is
    //    on the internet; with or without a Google account.
    //
    // * `allAuthenticatedUsers`: A special identifier that represents
    // anyone
    //    who is authenticated with a Google account or a service
    // account.
    //
    // * `user:{emailid}`: An email address that represents a specific
    // Google
    //    account. For example, `alice@gmail.com` .
    //
    //
    // * `serviceAccount:{emailid}`: An email address that represents a
    // service
    //    account. For example,
    // `my-other-app@appspot.gserviceaccount.com`.
    //
    // * `group:{emailid}`: An email address that represents a Google
    // group.
    //    For example, `admins@example.com`.
    //
    //
    // * `domain:{domain}`: The G Suite domain (primary) that represents all
    // the
    //    users of that domain. For example, `google.com` or
    // `example.com`.
    //
    //
    Members []string `json:"members,omitempty"`

    // Role: Role that is assigned to `members`.
    // For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
    Role string `json:"role,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Condition") 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. "Condition") 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:"-"`
}

Binding: Associates `members` with a `role`.

func (*Binding) MarshalJSON Uses

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

type CreateSnapshotRequest Uses

type CreateSnapshotRequest struct {
    // Labels: See <a href="https://cloud.google.com/pubsub/docs/labels">
    // Creating and
    // managing labels</a>.
    Labels map[string]string `json:"labels,omitempty"`

    // Subscription: The subscription whose backlog the snapshot
    // retains.
    // Specifically, the created snapshot is guaranteed to retain:
    //  (a) The existing backlog on the subscription. More precisely, this
    // is
    //      defined as the messages in the subscription's backlog that are
    //      unacknowledged upon the successful completion of the
    //      `CreateSnapshot` request; as well as:
    //  (b) Any messages published to the subscription's topic following
    // the
    //      successful completion of the CreateSnapshot request.
    // Format is `projects/{project}/subscriptions/{sub}`.
    Subscription string `json:"subscription,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Labels") 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. "Labels") 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:"-"`
}

CreateSnapshotRequest: Request for the `CreateSnapshot` method.

func (*CreateSnapshotRequest) MarshalJSON Uses

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

type Empty Uses

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

Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:

service Foo {
  rpc Bar(google.protobuf.Empty) returns

(google.protobuf.Empty);

}

The JSON representation for `Empty` is empty JSON object `{}`.

type ExpirationPolicy Uses

type ExpirationPolicy struct {
    // Ttl: Specifies the "time-to-live" duration for an associated
    // resource. The
    // resource expires if it is not active for a period of `ttl`. The
    // definition
    // of "activity" depends on the type of the associated resource. The
    // minimum
    // and maximum allowed values for `ttl` depend on the type of the
    // associated
    // resource, as well. If `ttl` is not set, the associated resource
    // never
    // expires.
    Ttl string `json:"ttl,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Ttl") 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. "Ttl") 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:"-"`
}

ExpirationPolicy: A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion).

func (*ExpirationPolicy) MarshalJSON Uses

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

type Expr Uses

type Expr struct {
    // Description: An optional description of the expression. This is a
    // longer text which
    // describes the expression, e.g. when hovered over it in a UI.
    Description string `json:"description,omitempty"`

    // Expression: Textual representation of an expression in
    // Common Expression Language syntax.
    //
    // The application context of the containing message determines
    // which
    // well-known feature set of CEL is supported.
    Expression string `json:"expression,omitempty"`

    // Location: An optional string indicating the location of the
    // expression for error
    // reporting, e.g. a file name and a position in the file.
    Location string `json:"location,omitempty"`

    // Title: An optional title for the expression, i.e. a short string
    // describing
    // its purpose. This can be used e.g. in UIs which allow to enter
    // the
    // expression.
    Title string `json:"title,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Description") 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. "Description") 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:"-"`
}

Expr: Represents an expression text. Example:

title: "User account presence"
description: "Determines whether the request has a user account"
expression: "size(request.user) > 0"

func (*Expr) MarshalJSON Uses

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

type ListSnapshotsResponse Uses

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

    // Snapshots: The resulting snapshots.
    Snapshots []*Snapshot `json:"snapshots,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:"-"`
}

ListSnapshotsResponse: Response for the `ListSnapshots` method.

func (*ListSnapshotsResponse) MarshalJSON Uses

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

type ListSubscriptionsResponse Uses

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

    // 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 Uses

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

type ListTopicSnapshotsResponse Uses

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

    // Snapshots: The names of the snapshots that match the request.
    Snapshots []string `json:"snapshots,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:"-"`
}

ListTopicSnapshotsResponse: Response for the `ListTopicSnapshots` method.

func (*ListTopicSnapshotsResponse) MarshalJSON Uses

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

type ListTopicSubscriptionsResponse Uses

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

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

ListTopicSubscriptionsResponse: Response for the `ListTopicSubscriptions` method.

func (*ListTopicSubscriptionsResponse) MarshalJSON Uses

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

type ListTopicsResponse Uses

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

    // 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 Uses

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

type MessageStoragePolicy Uses

type MessageStoragePolicy struct {
    // AllowedPersistenceRegions: A list of IDs of GCP regions where
    // messages that are published to the topic
    // may be persisted in storage. Messages published by publishers running
    // in
    // non-allowed GCP regions (or running outside of GCP altogether) will
    // be
    // routed for storage in one of the allowed regions. An empty list means
    // that
    // no regions are allowed, and is not a valid configuration.
    AllowedPersistenceRegions []string `json:"allowedPersistenceRegions,omitempty"`

    // ForceSendFields is a list of field names (e.g.
    // "AllowedPersistenceRegions") 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.
    // "AllowedPersistenceRegions") 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:"-"`
}

func (*MessageStoragePolicy) MarshalJSON Uses

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

type ModifyAckDeadlineRequest Uses

type ModifyAckDeadlineRequest struct {
    // AckDeadlineSeconds: The new ack deadline with respect to the time
    // this request was sent to
    // the Pub/Sub system. For example, if the value is 10, the new
    // ack deadline will expire 10 seconds after the `ModifyAckDeadline`
    // call
    // was made. Specifying zero might immediately make the message
    // available for
    // delivery to another subscriber client. This typically results in
    // an
    // increase in the rate of message redeliveries (that is,
    // duplicates).
    // The minimum deadline you can specify is 0 seconds.
    // The maximum deadline you can specify is 600 seconds (10 minutes).
    AckDeadlineSeconds int64 `json:"ackDeadlineSeconds,omitempty"`

    // AckIds: List of acknowledgment IDs.
    AckIds []string `json:"ackIds,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 Uses

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

type ModifyPushConfigRequest Uses

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` or `StreamingPull` is not called.
    PushConfig *PushConfig `json:"pushConfig,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 Uses

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

type OidcToken Uses

type OidcToken struct {
    // Audience: Audience to be used when generating OIDC token. The
    // audience claim
    // identifies the recipients that the JWT is intended for. The
    // audience
    // value is a single case-sensitive string. Having multiple values
    // (array)
    // for the audience field is not supported. More info about the OIDC
    // JWT
    // token audience here:
    // https://tools.ietf.org/html/rfc7519#section-4.1.3
    // Note: if not specified, the Push endpoint URL will be used.
    Audience string `json:"audience,omitempty"`

    // ServiceAccountEmail: [Service
    // account
    // email](https://cloud.google.com/iam/docs/service-accounts)
    // to be used for generating the OIDC token. The caller
    // (for
    // CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs)
    // must
    // have the iam.serviceAccounts.actAs permission for the service
    // account.
    ServiceAccountEmail string `json:"serviceAccountEmail,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Audience") 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. "Audience") 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:"-"`
}

OidcToken: Contains information needed for generating an [OpenID Connect token](https://developers.google.com/identity/protocols/OpenID Connect).

func (*OidcToken) MarshalJSON Uses

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

type Policy Uses

type Policy struct {
    // Bindings: Associates a list of `members` to a `role`.
    // `bindings` with no members will result in an error.
    Bindings []*Binding `json:"bindings,omitempty"`

    // Etag: `etag` is used for optimistic concurrency control as a way to
    // help
    // prevent simultaneous updates of a policy from overwriting each
    // other.
    // It is strongly suggested that systems make use of the `etag` in
    // the
    // read-modify-write cycle to perform policy updates in order to avoid
    // race
    // conditions: An `etag` is returned in the response to `getIamPolicy`,
    // and
    // systems are expected to put that etag in the request to
    // `setIamPolicy` to
    // ensure that their change will be applied to the same version of the
    // policy.
    //
    // If no `etag` is provided in the call to `setIamPolicy`, then the
    // existing
    // policy is overwritten blindly.
    Etag string `json:"etag,omitempty"`

    // Version: Deprecated.
    Version int64 `json:"version,omitempty"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Bindings") 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. "Bindings") 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:"-"`
}

Policy: Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.

A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM.

**JSON Example**

{
  "bindings": [
    {
      "role": "roles/owner",
      "members": [
        "user:mike@example.com",
        "group:admins@example.com",
        "domain:google.com",

"serviceAccount:my-other-app@appspot.gserviceaccount.com"

      ]
    },
    {
      "role": "roles/viewer",
      "members": ["user:sean@example.com"]
    }
  ]
}

**YAML Example**

bindings:
- members:
  - user:mike@example.com
  - group:admins@example.com
  - domain:google.com
  - serviceAccount:my-other-app@appspot.gserviceaccount.com
  role: roles/owner
- members:
  - user:sean@example.com
  role: roles/viewer

For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs).

func (*Policy) MarshalJSON Uses

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

type ProjectsService Uses

type ProjectsService struct {
    Snapshots *ProjectsSnapshotsService

    Subscriptions *ProjectsSubscriptionsService

    Topics *ProjectsTopicsService
    // contains filtered or unexported fields
}

func NewProjectsService Uses

func NewProjectsService(s *Service) *ProjectsService

type ProjectsSnapshotsCreateCall Uses

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

func (*ProjectsSnapshotsCreateCall) Context Uses

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

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 (*ProjectsSnapshotsCreateCall) Do Uses

func (c *ProjectsSnapshotsCreateCall) Do(opts ...googleapi.CallOption) (*Snapshot, error)

Do executes the "pubsub.projects.snapshots.create" call. Exactly one of *Snapshot or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Snapshot.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 (*ProjectsSnapshotsCreateCall) Fields Uses

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

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

func (*ProjectsSnapshotsCreateCall) Header Uses

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

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

type ProjectsSnapshotsDeleteCall Uses

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

func (*ProjectsSnapshotsDeleteCall) Context Uses

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

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 (*ProjectsSnapshotsDeleteCall) Do Uses

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

Do executes the "pubsub.projects.snapshots.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 (*ProjectsSnapshotsDeleteCall) Fields Uses

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

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

func (*ProjectsSnapshotsDeleteCall) Header Uses

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

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

type ProjectsSnapshotsGetCall Uses

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

func (*ProjectsSnapshotsGetCall) Context Uses

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

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 (*ProjectsSnapshotsGetCall) Do Uses

func (c *ProjectsSnapshotsGetCall) Do(opts ...googleapi.CallOption) (*Snapshot, error)

Do executes the "pubsub.projects.snapshots.get" call. Exactly one of *Snapshot or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Snapshot.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 (*ProjectsSnapshotsGetCall) Fields Uses

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

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

func (*ProjectsSnapshotsGetCall) Header Uses

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

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

func (*ProjectsSnapshotsGetCall) IfNoneMatch Uses

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

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 ProjectsSnapshotsGetIamPolicyCall Uses

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

func (*ProjectsSnapshotsGetIamPolicyCall) Context Uses

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

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 (*ProjectsSnapshotsGetIamPolicyCall) Do Uses

func (c *ProjectsSnapshotsGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)

Do executes the "pubsub.projects.snapshots.getIamPolicy" call. Exactly one of *Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Policy.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 (*ProjectsSnapshotsGetIamPolicyCall) Fields Uses

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

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

func (*ProjectsSnapshotsGetIamPolicyCall) Header Uses

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

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

func (*ProjectsSnapshotsGetIamPolicyCall) IfNoneMatch Uses

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

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 (*ProjectsSnapshotsGetIamPolicyCall) OptionsRequestedPolicyVersion Uses

func (c *ProjectsSnapshotsGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsSnapshotsGetIamPolicyCall

OptionsRequestedPolicyVersion sets the optional parameter "options.requestedPolicyVersion": The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned.

type ProjectsSnapshotsListCall Uses

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

func (*ProjectsSnapshotsListCall) Context Uses

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

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 (*ProjectsSnapshotsListCall) Do Uses

func (c *ProjectsSnapshotsListCall) Do(opts ...googleapi.CallOption) (*ListSnapshotsResponse, error)

Do executes the "pubsub.projects.snapshots.list" call. Exactly one of *ListSnapshotsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListSnapshotsResponse.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 (*ProjectsSnapshotsListCall) Fields Uses

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

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

func (*ProjectsSnapshotsListCall) Header Uses

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

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

func (*ProjectsSnapshotsListCall) IfNoneMatch Uses

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

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 (*ProjectsSnapshotsListCall) PageSize Uses

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

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

func (*ProjectsSnapshotsListCall) PageToken Uses

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

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

func (*ProjectsSnapshotsListCall) Pages Uses

func (c *ProjectsSnapshotsListCall) Pages(ctx context.Context, f func(*ListSnapshotsResponse) error) error

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

type ProjectsSnapshotsPatchCall Uses

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

func (*ProjectsSnapshotsPatchCall) Context Uses

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

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 (*ProjectsSnapshotsPatchCall) Do Uses

func (c *ProjectsSnapshotsPatchCall) Do(opts ...googleapi.CallOption) (*Snapshot, error)

Do executes the "pubsub.projects.snapshots.patch" call. Exactly one of *Snapshot or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Snapshot.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 (*ProjectsSnapshotsPatchCall) Fields Uses

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

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

func (*ProjectsSnapshotsPatchCall) Header Uses

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

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

type ProjectsSnapshotsService Uses

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

func NewProjectsSnapshotsService Uses

func NewProjectsSnapshotsService(s *Service) *ProjectsSnapshotsService

func (*ProjectsSnapshotsService) Create Uses

func (r *ProjectsSnapshotsService) Create(name string, createsnapshotrequest *CreateSnapshotRequest) *ProjectsSnapshotsCreateCall

Create: Creates a snapshot from the requested subscription. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> o perations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. <br><br>If the snapshot already exists, returns `ALREADY_EXISTS`. If the requested subscription doesn't exist, returns `NOT_FOUND`. If the backlog in the subscription is too old -- and the resulting snapshot would expire in less than 1 hour -- then `FAILED_PRECONDITION` is returned. See also the `Snapshot.expire_time` field. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription, conforming to the [resource name format](https://cloud.google.com/pubsub/docs/admin#resource_names ). The generated name is populated in the returned Snapshot object. Note that for REST API requests, you must specify a name in the request.

func (*ProjectsSnapshotsService) Delete Uses

func (r *ProjectsSnapshotsService) Delete(snapshot string) *ProjectsSnapshotsDeleteCall

Delete: Removes an existing snapshot. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> o perations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.<br><br> When the snapshot is deleted, all messages retained in the snapshot are immediately dropped. After a snapshot is deleted, a new one may be created with the same name, but the new one has no association with the old snapshot or its subscription, unless the same subscription is specified.

func (*ProjectsSnapshotsService) Get Uses

func (r *ProjectsSnapshotsService) Get(snapshot string) *ProjectsSnapshotsGetCall

Get: Gets the configuration details of a snapshot. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> o perations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

func (*ProjectsSnapshotsService) GetIamPolicy Uses

func (r *ProjectsSnapshotsService) GetIamPolicy(resource string) *ProjectsSnapshotsGetIamPolicyCall

GetIamPolicy: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

func (*ProjectsSnapshotsService) List Uses

func (r *ProjectsSnapshotsService) List(project string) *ProjectsSnapshotsListCall

List: Lists the existing snapshots. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> o perations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

func (*ProjectsSnapshotsService) Patch Uses

func (r *ProjectsSnapshotsService) Patch(name string, updatesnapshotrequest *UpdateSnapshotRequest) *ProjectsSnapshotsPatchCall

Patch: Updates an existing snapshot. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> o perations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

func (*ProjectsSnapshotsService) SetIamPolicy Uses

func (r *ProjectsSnapshotsService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsSnapshotsSetIamPolicyCall

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

func (*ProjectsSnapshotsService) TestIamPermissions Uses

func (r *ProjectsSnapshotsService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsSnapshotsTestIamPermissionsCall

TestIamPermissions: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

type ProjectsSnapshotsSetIamPolicyCall Uses

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

func (*ProjectsSnapshotsSetIamPolicyCall) Context Uses

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

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 (*ProjectsSnapshotsSetIamPolicyCall) Do Uses

func (c *ProjectsSnapshotsSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)

Do executes the "pubsub.projects.snapshots.setIamPolicy" call. Exactly one of *Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Policy.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 (*ProjectsSnapshotsSetIamPolicyCall) Fields Uses

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

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

func (*ProjectsSnapshotsSetIamPolicyCall) Header Uses

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

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

type ProjectsSnapshotsTestIamPermissionsCall Uses

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

func (*ProjectsSnapshotsTestIamPermissionsCall) Context Uses

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

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 (*ProjectsSnapshotsTestIamPermissionsCall) Do Uses

func (c *ProjectsSnapshotsTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)

Do executes the "pubsub.projects.snapshots.testIamPermissions" call. Exactly one of *TestIamPermissionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.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 (*ProjectsSnapshotsTestIamPermissionsCall) Fields Uses

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

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

func (*ProjectsSnapshotsTestIamPermissionsCall) Header Uses

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

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

type ProjectsSubscriptionsAcknowledgeCall Uses

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

func (*ProjectsSubscriptionsAcknowledgeCall) Context Uses

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

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 (*ProjectsSubscriptionsAcknowledgeCall) Do Uses

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

Do executes the "pubsub.projects.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 (*ProjectsSubscriptionsAcknowledgeCall) Fields Uses

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.

func (*ProjectsSubscriptionsAcknowledgeCall) Header Uses

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

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

type ProjectsSubscriptionsCreateCall Uses

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

func (*ProjectsSubscriptionsCreateCall) Context Uses

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

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 (*ProjectsSubscriptionsCreateCall) Do Uses

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

Do executes the "pubsub.projects.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 (*ProjectsSubscriptionsCreateCall) Fields Uses

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.

func (*ProjectsSubscriptionsCreateCall) Header Uses

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

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

type ProjectsSubscriptionsDeleteCall Uses

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

func (*ProjectsSubscriptionsDeleteCall) Context Uses

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

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 (*ProjectsSubscriptionsDeleteCall) Do Uses

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

Do executes the "pubsub.projects.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 (*ProjectsSubscriptionsDeleteCall) Fields Uses

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.

func (*ProjectsSubscriptionsDeleteCall) Header Uses

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

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

type ProjectsSubscriptionsGetCall Uses

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

func (*ProjectsSubscriptionsGetCall) Context Uses

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

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 (*ProjectsSubscriptionsGetCall) Do Uses

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

Do executes the "pubsub.projects.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 (*ProjectsSubscriptionsGetCall) Fields Uses

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.

func (*ProjectsSubscriptionsGetCall) Header Uses

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

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

func (*ProjectsSubscriptionsGetCall) IfNoneMatch Uses

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

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 ProjectsSubscriptionsGetIamPolicyCall Uses

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

func (*ProjectsSubscriptionsGetIamPolicyCall) Context Uses

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

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 (*ProjectsSubscriptionsGetIamPolicyCall) Do Uses

func (c *ProjectsSubscriptionsGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)

Do executes the "pubsub.projects.subscriptions.getIamPolicy" call. Exactly one of *Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Policy.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 (*ProjectsSubscriptionsGetIamPolicyCall) Fields Uses

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.

func (*ProjectsSubscriptionsGetIamPolicyCall) Header Uses

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

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

func (*ProjectsSubscriptionsGetIamPolicyCall) IfNoneMatch Uses

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

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 (*ProjectsSubscriptionsGetIamPolicyCall) OptionsRequestedPolicyVersion Uses

func (c *ProjectsSubscriptionsGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsSubscriptionsGetIamPolicyCall

OptionsRequestedPolicyVersion sets the optional parameter "options.requestedPolicyVersion": The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned.

type ProjectsSubscriptionsListCall Uses

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

func (*ProjectsSubscriptionsListCall) Context Uses

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

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 (*ProjectsSubscriptionsListCall) Do Uses

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

Do executes the "pubsub.projects.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 (*ProjectsSubscriptionsListCall) Fields Uses

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) Header Uses

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

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

func (*ProjectsSubscriptionsListCall) IfNoneMatch Uses

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

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 (*ProjectsSubscriptionsListCall) PageSize Uses

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

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

func (*ProjectsSubscriptionsListCall) PageToken Uses

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.

func (*ProjectsSubscriptionsListCall) Pages Uses

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

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

type ProjectsSubscriptionsModifyAckDeadlineCall Uses

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

func (*ProjectsSubscriptionsModifyAckDeadlineCall) Context Uses

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

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 (*ProjectsSubscriptionsModifyAckDeadlineCall) Do Uses

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

Do executes the "pubsub.projects.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 (*ProjectsSubscriptionsModifyAckDeadlineCall) Fields Uses

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.

func (*ProjectsSubscriptionsModifyAckDeadlineCall) Header Uses

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

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

type ProjectsSubscriptionsModifyPushConfigCall Uses

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

func (*ProjectsSubscriptionsModifyPushConfigCall) Context Uses

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

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 (*ProjectsSubscriptionsModifyPushConfigCall) Do Uses

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

Do executes the "pubsub.projects.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 (*ProjectsSubscriptionsModifyPushConfigCall) Fields Uses

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.

func (*ProjectsSubscriptionsModifyPushConfigCall) Header Uses

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

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

type ProjectsSubscriptionsPatchCall Uses

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

func (*ProjectsSubscriptionsPatchCall) Context Uses

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

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 (*ProjectsSubscriptionsPatchCall) Do Uses

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

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

func (*ProjectsSubscriptionsPatchCall) Fields Uses

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

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

func (*ProjectsSubscriptionsPatchCall) Header Uses

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

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

type ProjectsSubscriptionsPullCall Uses

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

func (*ProjectsSubscriptionsPullCall) Context Uses

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

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 (*ProjectsSubscriptionsPullCall) Do Uses

func (c *ProjectsSubscriptionsPullCall) Do(opts ...googleapi.CallOption) (*PullResponse, error)

Do executes the "pubsub.projects.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 (*ProjectsSubscriptionsPullCall) Fields Uses

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.

func (*ProjectsSubscriptionsPullCall) Header Uses

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

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

type ProjectsSubscriptionsSeekCall Uses

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

func (*ProjectsSubscriptionsSeekCall) Context Uses

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

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 (*ProjectsSubscriptionsSeekCall) Do Uses

func (c *ProjectsSubscriptionsSeekCall) Do(opts ...googleapi.CallOption) (*SeekResponse, error)

Do executes the "pubsub.projects.subscriptions.seek" call. Exactly one of *SeekResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *SeekResponse.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 (*ProjectsSubscriptionsSeekCall) Fields Uses

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

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

func (*ProjectsSubscriptionsSeekCall) Header Uses

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

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

type ProjectsSubscriptionsService Uses

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

func NewProjectsSubscriptionsService Uses

func NewProjectsSubscriptionsService(s *Service) *ProjectsSubscriptionsService

func (*ProjectsSubscriptionsService) Acknowledge Uses

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

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

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

func (*ProjectsSubscriptionsService) Create Uses

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

Create: Creates a subscription to a given topic. See the <a href="https://cloud.google.com/pubsub/docs/admin#resource_names"> reso urce name rules</a>. If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`.

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

func (*ProjectsSubscriptionsService) Delete Uses

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

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

func (*ProjectsSubscriptionsService) Get Uses

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

Get: Gets the configuration details of a subscription.

func (*ProjectsSubscriptionsService) GetIamPolicy Uses

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

GetIamPolicy: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

func (*ProjectsSubscriptionsService) List Uses

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

List: Lists matching subscriptions.

func (*ProjectsSubscriptionsService) ModifyAckDeadline Uses

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. Note that this does not modify the subscription-level `ackDeadlineSeconds` used for subsequent messages.

func (*ProjectsSubscriptionsService) ModifyPushConfig Uses

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) Patch Uses

func (r *ProjectsSubscriptionsService) Patch(name string, updatesubscriptionrequest *UpdateSubscriptionRequest) *ProjectsSubscriptionsPatchCall

Patch: Updates an existing subscription. Note that certain properties of a subscription, such as its topic, are not modifiable.

func (*ProjectsSubscriptionsService) Pull Uses

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

Pull: Pulls messages from the server. The server may return `UNAVAILABLE` if there are too many concurrent pull requests pending for the given subscription.

func (*ProjectsSubscriptionsService) Seek Uses

func (r *ProjectsSubscriptionsService) Seek(subscription string, seekrequest *SeekRequest) *ProjectsSubscriptionsSeekCall

Seek: Seeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> o perations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. Note that both the subscription and the snapshot must be on the same topic.

func (*ProjectsSubscriptionsService) SetIamPolicy Uses

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 Uses

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

TestIamPermissions: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

type ProjectsSubscriptionsSetIamPolicyCall Uses

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

func (*ProjectsSubscriptionsSetIamPolicyCall) Context Uses

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

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 (*ProjectsSubscriptionsSetIamPolicyCall) Do Uses

func (c *ProjectsSubscriptionsSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)

Do executes the "pubsub.projects.subscriptions.setIamPolicy" call. Exactly one of *Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Policy.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 (*ProjectsSubscriptionsSetIamPolicyCall) Fields Uses

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.

func (*ProjectsSubscriptionsSetIamPolicyCall) Header Uses

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

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

type ProjectsSubscriptionsTestIamPermissionsCall Uses

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

func (*ProjectsSubscriptionsTestIamPermissionsCall) Context Uses

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

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 (*ProjectsSubscriptionsTestIamPermissionsCall) Do Uses

func (c *ProjectsSubscriptionsTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)

Do executes the "pubsub.projects.subscriptions.testIamPermissions" call. Exactly one of *TestIamPermissionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.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 (*ProjectsSubscriptionsTestIamPermissionsCall) Fields Uses

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.

func (*ProjectsSubscriptionsTestIamPermissionsCall) Header Uses

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

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

type ProjectsTopicsCreateCall Uses

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

func (*ProjectsTopicsCreateCall) Context Uses

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

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 (*ProjectsTopicsCreateCall) Do Uses

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

Do executes the "pubsub.projects.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 (*ProjectsTopicsCreateCall) Fields Uses

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.

func (*ProjectsTopicsCreateCall) Header Uses

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

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

type ProjectsTopicsDeleteCall Uses

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

func (*ProjectsTopicsDeleteCall) Context Uses

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

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 (*ProjectsTopicsDeleteCall) Do Uses

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

Do executes the "pubsub.projects.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 (*ProjectsTopicsDeleteCall) Fields Uses

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.

func (*ProjectsTopicsDeleteCall) Header Uses

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

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

type ProjectsTopicsGetCall Uses

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

func (*ProjectsTopicsGetCall) Context Uses

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

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 (*ProjectsTopicsGetCall) Do Uses

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

Do executes the "pubsub.projects.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 (*ProjectsTopicsGetCall) Fields Uses

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.

func (*ProjectsTopicsGetCall) Header Uses

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

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

func (*ProjectsTopicsGetCall) IfNoneMatch Uses

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

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 ProjectsTopicsGetIamPolicyCall Uses

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

func (*ProjectsTopicsGetIamPolicyCall) Context Uses

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

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 (*ProjectsTopicsGetIamPolicyCall) Do Uses

func (c *ProjectsTopicsGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)

Do executes the "pubsub.projects.topics.getIamPolicy" call. Exactly one of *Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Policy.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 (*ProjectsTopicsGetIamPolicyCall) Fields Uses

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.

func (*ProjectsTopicsGetIamPolicyCall) Header Uses

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

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

func (*ProjectsTopicsGetIamPolicyCall) IfNoneMatch Uses

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

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 (*ProjectsTopicsGetIamPolicyCall) OptionsRequestedPolicyVersion Uses

func (c *ProjectsTopicsGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsTopicsGetIamPolicyCall

OptionsRequestedPolicyVersion sets the optional parameter "options.requestedPolicyVersion": The policy format version to be returned. Acceptable values are 0 and 1. If the value is 0, or the field is omitted, policy format version 1 will be returned.

type ProjectsTopicsListCall Uses

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

func (*ProjectsTopicsListCall) Context Uses

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

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 (*ProjectsTopicsListCall) Do Uses

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

Do executes the "pubsub.projects.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 (*ProjectsTopicsListCall) Fields Uses

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) Header Uses

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

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

func (*ProjectsTopicsListCall) IfNoneMatch Uses

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

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 (*ProjectsTopicsListCall) PageSize Uses

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

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

func (*ProjectsTopicsListCall) PageToken Uses

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.

func (*ProjectsTopicsListCall) Pages Uses

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

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

type ProjectsTopicsPatchCall Uses

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

func (*ProjectsTopicsPatchCall) Context Uses

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

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 (*ProjectsTopicsPatchCall) Do Uses

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

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

func (*ProjectsTopicsPatchCall) Fields Uses

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

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

func (*ProjectsTopicsPatchCall) Header Uses

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

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

type ProjectsTopicsPublishCall Uses

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

func (*ProjectsTopicsPublishCall) Context Uses

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

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 (*ProjectsTopicsPublishCall) Do Uses

func (c *ProjectsTopicsPublishCall) Do(opts ...googleapi.CallOption) (*PublishResponse, error)

Do executes the "pubsub.projects.topics.publish" call. Exactly one of *PublishResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *PublishResponse.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 (*ProjectsTopicsPublishCall) Fields Uses

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.

func (*ProjectsTopicsPublishCall) Header Uses

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

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

type ProjectsTopicsService Uses

type ProjectsTopicsService struct {
    Snapshots *ProjectsTopicsSnapshotsService

    Subscriptions *ProjectsTopicsSubscriptionsService
    // contains filtered or unexported fields
}

func NewProjectsTopicsService Uses

func NewProjectsTopicsService(s *Service) *ProjectsTopicsService

func (*ProjectsTopicsService) Create Uses

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

Create: Creates the given topic with the given name. See the <a href="https://cloud.google.com/pubsub/docs/admin#resource_names"> reso urce name rules</a>.

func (*ProjectsTopicsService) Delete Uses

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 Uses

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

Get: Gets the configuration of a topic.

func (*ProjectsTopicsService) GetIamPolicy Uses

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

GetIamPolicy: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

func (*ProjectsTopicsService) List Uses

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

List: Lists matching topics.

func (*ProjectsTopicsService) Patch Uses

func (r *ProjectsTopicsService) Patch(name string, updatetopicrequest *UpdateTopicRequest) *ProjectsTopicsPatchCall

Patch: Updates an existing topic. Note that certain properties of a topic are not modifiable.

func (*ProjectsTopicsService) Publish Uses

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.

func (*ProjectsTopicsService) SetIamPolicy Uses

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 Uses

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

TestIamPermissions: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

type ProjectsTopicsSetIamPolicyCall Uses

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

func (*ProjectsTopicsSetIamPolicyCall) Context Uses

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

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 (*ProjectsTopicsSetIamPolicyCall) Do Uses

func (c *ProjectsTopicsSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)

Do executes the "pubsub.projects.topics.setIamPolicy" call. Exactly one of *Policy or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Policy.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 (*ProjectsTopicsSetIamPolicyCall) Fields Uses

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.

func (*ProjectsTopicsSetIamPolicyCall) Header Uses

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

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

type ProjectsTopicsSnapshotsListCall Uses

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

func (*ProjectsTopicsSnapshotsListCall) Context Uses

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

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 (*ProjectsTopicsSnapshotsListCall) Do Uses

func (c *ProjectsTopicsSnapshotsListCall) Do(opts ...googleapi.CallOption) (*ListTopicSnapshotsResponse, error)

Do executes the "pubsub.projects.topics.snapshots.list" call. Exactly one of *ListTopicSnapshotsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListTopicSnapshotsResponse.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 (*ProjectsTopicsSnapshotsListCall) Fields Uses

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

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

func (*ProjectsTopicsSnapshotsListCall) Header Uses

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

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

func (*ProjectsTopicsSnapshotsListCall) IfNoneMatch Uses

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

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 (*ProjectsTopicsSnapshotsListCall) PageSize Uses

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

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

func (*ProjectsTopicsSnapshotsListCall) PageToken Uses

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

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

func (*ProjectsTopicsSnapshotsListCall) Pages Uses

func (c *ProjectsTopicsSnapshotsListCall) Pages(ctx context.Context, f func(*ListTopicSnapshotsResponse) error) error

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

type ProjectsTopicsSnapshotsService Uses

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

func NewProjectsTopicsSnapshotsService Uses

func NewProjectsTopicsSnapshotsService(s *Service) *ProjectsTopicsSnapshotsService

func (*ProjectsTopicsSnapshotsService) List Uses

func (r *ProjectsTopicsSnapshotsService) List(topic string) *ProjectsTopicsSnapshotsListCall

List: Lists the names of the snapshots on this topic. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> o perations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

type ProjectsTopicsSubscriptionsListCall Uses

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

func (*ProjectsTopicsSubscriptionsListCall) Context Uses

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

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 (*ProjectsTopicsSubscriptionsListCall) Do Uses

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

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

func (*ProjectsTopicsSubscriptionsListCall) Fields Uses

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) Header Uses

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

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

func (*ProjectsTopicsSubscriptionsListCall) IfNoneMatch Uses

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

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 (*ProjectsTopicsSubscriptionsListCall) PageSize Uses

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

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

func (*ProjectsTopicsSubscriptionsListCall) PageToken Uses

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.

func (*ProjectsTopicsSubscriptionsListCall) Pages Uses

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

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

type ProjectsTopicsSubscriptionsService Uses

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

func NewProjectsTopicsSubscriptionsService Uses

func NewProjectsTopicsSubscriptionsService(s *Service) *ProjectsTopicsSubscriptionsService

func (*ProjectsTopicsSubscriptionsService) List Uses

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

List: Lists the names of the subscriptions on this topic.

type ProjectsTopicsTestIamPermissionsCall Uses

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

func (*ProjectsTopicsTestIamPermissionsCall) Context Uses

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

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 (*ProjectsTopicsTestIamPermissionsCall) Do Uses

func (c *ProjectsTopicsTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)

Do executes the "pubsub.projects.topics.testIamPermissions" call. Exactly one of *TestIamPermissionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.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 (*ProjectsTopicsTestIamPermissionsCall) Fields Uses

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.

func (*ProjectsTopicsTestIamPermissionsCall) Header Uses

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

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

type PublishRequest Uses

type PublishRequest struct {
    // Messages: The messages to publish.
    Messages []*PubsubMessage `json:"messages,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:"-"`
}

PublishRequest: Request for the Publish method.

func (*PublishRequest) MarshalJSON Uses

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

type PublishResponse Uses

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

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

PublishResponse: Response for the `Publish` method.

func (*PublishResponse) MarshalJSON Uses

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

type PubsubMessage Uses

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

    // Data: The message data field. If this field is empty, the message
    // must contain
    // at least one attribute.
    Data string `json:"data,omitempty"`

    // MessageId: ID of this message, assigned by the server when the
    // message is published.
    // 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 the publisher in a `Publish`
    // call.
    MessageId string `json:"messageId,omitempty"`

    // PublishTime: The time at which the message was published, populated
    // by the server when
    // it receives the `Publish` call. It must not be populated by
    // the
    // publisher in a `Publish` call.
    PublishTime string `json:"publishTime,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Attributes") 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. "Attributes") 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 that is published by publishers and consumed by subscribers. The message must contain either a non-empty data field or at least one attribute. Note that client libraries represent this object differently depending on the language. See the corresponding <a href="https://cloud.google.com/pubsub/docs/reference/libraries">client

library documentation</a> for more information. See <a href="https://cloud.google.com/pubsub/quotas">Quotas and limits</a> for more information about message limits.

func (*PubsubMessage) MarshalJSON Uses

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

type PullRequest Uses

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 field set to true, the system will respond
    // immediately even if
    // it there are no messages available to return in the `Pull`
    // response.
    // Otherwise, the system may wait (for a bounded amount of time) until
    // at
    // least one message is available, rather than returning no messages.
    ReturnImmediately bool `json:"returnImmediately,omitempty"`

    // ForceSendFields is a list of field names (e.g. "MaxMessages") 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. "MaxMessages") 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 Uses

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

type PullResponse Uses

type PullResponse struct {
    // ReceivedMessages: Received Pub/Sub messages. The list will be empty
    // if there are no more
    // messages available in the backlog. For JSON, the response can be
    // entirely
    // empty. 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"`

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "ReceivedMessages") 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. "ReceivedMessages") 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: Response for the `Pull` method.

func (*PullResponse) MarshalJSON Uses

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

type PushConfig Uses

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 pushed message. This
    // attribute
    // indicates the version of the data expected by the endpoint.
    // This
    // controls the shape of the pushed message (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"`

    // OidcToken: If specified, Pub/Sub will generate and attach an OIDC JWT
    // token as an
    // `Authorization` header in the HTTP request for every pushed message.
    OidcToken *OidcToken `json:"oidcToken,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"`

    // ForceSendFields is a list of field names (e.g. "Attributes") 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. "Attributes") 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 Uses

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

type ReceivedMessage Uses

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

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

ReceivedMessage: A message and its corresponding acknowledgment ID.

func (*ReceivedMessage) MarshalJSON Uses

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

type SeekRequest Uses

type SeekRequest struct {
    // Snapshot: The snapshot to seek to. The snapshot's topic must be the
    // same as that of
    // the provided subscription.
    // Format is `projects/{project}/snapshots/{snap}`.
    Snapshot string `json:"snapshot,omitempty"`

    // Time: The time to seek to.
    // Messages retained in the subscription that were published before
    // this
    // time are marked as acknowledged, and messages retained in
    // the
    // subscription that were published after this time are marked
    // as
    // unacknowledged. Note that this operation affects only those
    // messages
    // retained in the subscription (configured by the combination
    // of
    // `message_retention_duration` and `retain_acked_messages`). For
    // example,
    // if `time` corresponds to a point before the message retention
    // window (or to a point before the system's notion of the
    // subscription
    // creation time), only retained messages will be marked as
    // unacknowledged,
    // and already-expunged messages will not be restored.
    Time string `json:"time,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Snapshot") 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. "Snapshot") 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:"-"`
}

SeekRequest: Request for the `Seek` method.

func (*SeekRequest) MarshalJSON Uses

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

type SeekResponse Uses

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

SeekResponse: Response for the `Seek` method (this response is empty).

type Service Uses

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 Uses

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

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

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

func NewService Uses

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

NewService creates a new Service.

type SetIamPolicyRequest Uses

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 a
    // valid policy but certain Cloud Platform services (such as
    // Projects)
    // might reject them.
    Policy *Policy `json:"policy,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Policy") 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. "Policy") 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:"-"`
}

SetIamPolicyRequest: Request message for `SetIamPolicy` method.

func (*SetIamPolicyRequest) MarshalJSON Uses

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

type Snapshot Uses

type Snapshot struct {
    // ExpireTime: The snapshot is guaranteed to exist up until this time.
    // A newly-created snapshot expires no later than 7 days from the time
    // of its
    // creation. Its exact lifetime is determined at creation by the
    // existing
    // backlog in the source subscription. Specifically, the lifetime of
    // the
    // snapshot is `7 days - (age of oldest unacked message in the
    // subscription)`.
    // For example, consider a subscription whose oldest unacked message is
    // 3 days
    // old. If a snapshot is created from this subscription, the snapshot --
    // which
    // will always capture this 3-day-old backlog as long as the
    // snapshot
    // exists -- will expire in 4 days. The service will refuse to create
    // a
    // snapshot that would expire in less than 1 hour after creation.
    ExpireTime string `json:"expireTime,omitempty"`

    // Labels: See <a href="https://cloud.google.com/pubsub/docs/labels">
    // Creating and
    // managing labels</a>.
    Labels map[string]string `json:"labels,omitempty"`

    // Name: The name of the snapshot.
    Name string `json:"name,omitempty"`

    // Topic: The name of the topic from which this snapshot is retaining
    // 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. "ExpireTime") 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. "ExpireTime") 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:"-"`
}

Snapshot: A snapshot resource. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> o perations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.

func (*Snapshot) MarshalJSON Uses

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

type Subscription Uses

type Subscription struct {
    // AckDeadlineSeconds: The approximate amount of time (on a best-effort
    // basis) Pub/Sub waits for
    // the subscriber to acknowledge receipt before resending the message.
    // In the
    // interval after the message is delivered and before it is
    // acknowledged, it
    // is considered to be <i>outstanding</i>. During that time period,
    // the
    // message will not be redelivered (on a best-effort basis).
    //
    // For pull subscriptions, 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` if
    // using
    // non-streaming pull or send the `ack_id` in
    // a
    // `StreamingModifyAckDeadlineRequest` if using streaming pull.
    // The minimum custom deadline you can specify is 10 seconds.
    // The maximum custom deadline you can specify is 600 seconds (10
    // minutes).
    // If this parameter is 0, a default value of 10 seconds is used.
    //
    // 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.
    AckDeadlineSeconds int64 `json:"ackDeadlineSeconds,omitempty"`

    // ExpirationPolicy: A policy that specifies the conditions for this
    // subscription's expiration.
    // A subscription is considered active as long as any connected
    // subscriber is
    // successfully consuming messages from the subscription or is
    // issuing
    // operations on the subscription. If `expiration_policy` is not set,
    // a
    // *default policy* with `ttl` of 31 days will be used. The minimum
    // allowed
    // value for `expiration_policy.ttl` is 1 day.
    ExpirationPolicy *ExpirationPolicy `json:"expirationPolicy,omitempty"`

    // Labels: See <a href="https://cloud.google.com/pubsub/docs/labels">
    // Creating and
    // managing labels</a>.
    Labels map[string]string `json:"labels,omitempty"`

    // MessageRetentionDuration: How long to retain unacknowledged messages
    // in the subscription's backlog,
    // from the moment a message is published.
    // If `retain_acked_messages` is true, then this also configures the
    // retention
    // of acknowledged messages, and thus configures how far back in time a
    // `Seek`
    // can be done. Defaults to 7 days. Cannot be more than 7 days or less
    // than 10
    // minutes.
    MessageRetentionDuration string `json:"messageRetentionDuration,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"`

    // RetainAckedMessages: Indicates whether to retain acknowledged
    // messages. If true, then
    // messages are not expunged from the subscription's backlog, even if
    // they are
    // acknowledged, until they fall out of the
    // `message_retention_duration`
    // window. This must be true if you would like
    // to
    // <a
    // href="https://cloud.google.com/pubsub/docs/replay-overview#seek_
    // to_a_time">
    // Seek to a timestamp</a>.
    RetainAckedMessages bool `json:"retainAckedMessages,omitempty"`

    // Topic: The name of the topic from which this subscription is
    // receiving messages.
    // Format is `projects/{project}/topics/{topic}`.
    // The value of this field will be `_deleted-topic_` if the topic has
    // been
    // deleted.
    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 Uses

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

type TestIamPermissionsRequest Uses

type TestIamPermissionsRequest struct {
    // Permissions: The set of permissions to check for the `resource`.
    // Permissions with
    // wildcards (such as '*' or 'storage.*') are not allowed. For
    // more
    // information see
    // [IAM
    // Overview](https://cloud.google.com/iam/docs/overview#permissions).
    Permissions []string `json:"permissions,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Permissions") 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. "Permissions") 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:"-"`
}

TestIamPermissionsRequest: Request message for `TestIamPermissions` method.

func (*TestIamPermissionsRequest) MarshalJSON Uses

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

type TestIamPermissionsResponse Uses

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

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "Permissions") 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. "Permissions") 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:"-"`
}

TestIamPermissionsResponse: Response message for `TestIamPermissions` method.

func (*TestIamPermissionsResponse) MarshalJSON Uses

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

type Topic Uses

type Topic struct {
    // KmsKeyName: The resource name of the Cloud KMS CryptoKey to be used
    // to protect access
    // to messages published on this topic.
    //
    // The expected format is
    // `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
    KmsKeyName string `json:"kmsKeyName,omitempty"`

    // Labels: See <a href="https://cloud.google.com/pubsub/docs/labels">
    // Creating and
    // managing labels</a>.
    Labels map[string]string `json:"labels,omitempty"`

    // MessageStoragePolicy: Policy constraining the set of Google Cloud
    // Platform regions where messages
    // published to the topic may be stored. If not present, then no
    // constraints
    // are in effect.
    MessageStoragePolicy *MessageStoragePolicy `json:"messageStoragePolicy,omitempty"`

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

    // ServerResponse contains the HTTP response code and headers from the
    // server.
    googleapi.ServerResponse `json:"-"`

    // ForceSendFields is a list of field names (e.g. "KmsKeyName") 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. "KmsKeyName") 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 Uses

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

type UpdateSnapshotRequest Uses

type UpdateSnapshotRequest struct {
    // Snapshot: The updated snapshot object.
    Snapshot *Snapshot `json:"snapshot,omitempty"`

    // UpdateMask: Indicates which fields in the provided snapshot to
    // update.
    // Must be specified and non-empty.
    UpdateMask string `json:"updateMask,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Snapshot") 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. "Snapshot") 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:"-"`
}

UpdateSnapshotRequest: Request for the UpdateSnapshot method.

func (*UpdateSnapshotRequest) MarshalJSON Uses

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

type UpdateSubscriptionRequest Uses

type UpdateSubscriptionRequest struct {
    // Subscription: The updated subscription object.
    Subscription *Subscription `json:"subscription,omitempty"`

    // UpdateMask: Indicates which fields in the provided subscription to
    // update.
    // Must be specified and non-empty.
    UpdateMask string `json:"updateMask,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Subscription") 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. "Subscription") 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:"-"`
}

UpdateSubscriptionRequest: Request for the UpdateSubscription method.

func (*UpdateSubscriptionRequest) MarshalJSON Uses

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

type UpdateTopicRequest Uses

type UpdateTopicRequest struct {
    // Topic: The updated topic object.
    Topic *Topic `json:"topic,omitempty"`

    // UpdateMask: Indicates which fields in the provided topic to update.
    // Must be specified
    // and non-empty. Note that if `update_mask`
    // contains
    // "message_storage_policy" then the new value will be determined based
    // on the
    // policy configured at the project or organization level.
    // The
    // `message_storage_policy` must not be set in the `topic` provided
    // above.
    UpdateMask string `json:"updateMask,omitempty"`

    // ForceSendFields is a list of field names (e.g. "Topic") 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. "Topic") to include in API
    // requests with the JSON null value. By default, fields with empty
    // values are omitted from API requests. However, any field with an
    // empty value appearing in NullFields will be sent to the server as
    // null. It is an error if a field in this list has a non-empty value.
    // This may be used to include null fields in Patch requests.
    NullFields []string `json:"-"`
}

UpdateTopicRequest: Request for the UpdateTopic method.

func (*UpdateTopicRequest) MarshalJSON Uses

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

Package pubsub imports 14 packages (graph) and is imported by 116 packages. Updated 2019-07-12. Refresh now. Tools for package owners.