Documentation ¶
Overview ¶
Package pubsub provides access to the Cloud Pub/Sub API.
This package is DEPRECATED. Use package cloud.google.com/go/pubsub instead.
For product documentation, see: https://cloud.google.com/pubsub/docs
Creating a client ¶
Usage example:
import "google.golang.org/api/pubsub/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 ¶
- Constants
- type AcknowledgeRequest
- type Binding
- type CreateSnapshotRequest
- type DeadLetterPolicy
- type DetachSubscriptionResponse
- type Empty
- type ExpirationPolicy
- type Expr
- type ListSchemasResponse
- type ListSnapshotsResponse
- type ListSubscriptionsResponse
- type ListTopicSnapshotsResponse
- type ListTopicSubscriptionsResponse
- type ListTopicsResponse
- type MessageStoragePolicy
- type ModifyAckDeadlineRequest
- type ModifyPushConfigRequest
- type OidcToken
- type Policy
- type ProjectsSchemasCreateCall
- func (c *ProjectsSchemasCreateCall) Context(ctx context.Context) *ProjectsSchemasCreateCall
- func (c *ProjectsSchemasCreateCall) Do(opts ...googleapi.CallOption) (*Schema, error)
- func (c *ProjectsSchemasCreateCall) Fields(s ...googleapi.Field) *ProjectsSchemasCreateCall
- func (c *ProjectsSchemasCreateCall) Header() http.Header
- func (c *ProjectsSchemasCreateCall) SchemaId(schemaId string) *ProjectsSchemasCreateCall
- type ProjectsSchemasDeleteCall
- func (c *ProjectsSchemasDeleteCall) Context(ctx context.Context) *ProjectsSchemasDeleteCall
- func (c *ProjectsSchemasDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *ProjectsSchemasDeleteCall) Fields(s ...googleapi.Field) *ProjectsSchemasDeleteCall
- func (c *ProjectsSchemasDeleteCall) Header() http.Header
- type ProjectsSchemasGetCall
- func (c *ProjectsSchemasGetCall) Context(ctx context.Context) *ProjectsSchemasGetCall
- func (c *ProjectsSchemasGetCall) Do(opts ...googleapi.CallOption) (*Schema, error)
- func (c *ProjectsSchemasGetCall) Fields(s ...googleapi.Field) *ProjectsSchemasGetCall
- func (c *ProjectsSchemasGetCall) Header() http.Header
- func (c *ProjectsSchemasGetCall) IfNoneMatch(entityTag string) *ProjectsSchemasGetCall
- func (c *ProjectsSchemasGetCall) View(view string) *ProjectsSchemasGetCall
- type ProjectsSchemasGetIamPolicyCall
- func (c *ProjectsSchemasGetIamPolicyCall) Context(ctx context.Context) *ProjectsSchemasGetIamPolicyCall
- func (c *ProjectsSchemasGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
- func (c *ProjectsSchemasGetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsSchemasGetIamPolicyCall
- func (c *ProjectsSchemasGetIamPolicyCall) Header() http.Header
- func (c *ProjectsSchemasGetIamPolicyCall) IfNoneMatch(entityTag string) *ProjectsSchemasGetIamPolicyCall
- func (c *ProjectsSchemasGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsSchemasGetIamPolicyCall
- type ProjectsSchemasListCall
- func (c *ProjectsSchemasListCall) Context(ctx context.Context) *ProjectsSchemasListCall
- func (c *ProjectsSchemasListCall) Do(opts ...googleapi.CallOption) (*ListSchemasResponse, error)
- func (c *ProjectsSchemasListCall) Fields(s ...googleapi.Field) *ProjectsSchemasListCall
- func (c *ProjectsSchemasListCall) Header() http.Header
- func (c *ProjectsSchemasListCall) IfNoneMatch(entityTag string) *ProjectsSchemasListCall
- func (c *ProjectsSchemasListCall) PageSize(pageSize int64) *ProjectsSchemasListCall
- func (c *ProjectsSchemasListCall) PageToken(pageToken string) *ProjectsSchemasListCall
- func (c *ProjectsSchemasListCall) Pages(ctx context.Context, f func(*ListSchemasResponse) error) error
- func (c *ProjectsSchemasListCall) View(view string) *ProjectsSchemasListCall
- type ProjectsSchemasService
- func (r *ProjectsSchemasService) Create(parent string, schema *Schema) *ProjectsSchemasCreateCall
- func (r *ProjectsSchemasService) Delete(name string) *ProjectsSchemasDeleteCall
- func (r *ProjectsSchemasService) Get(name string) *ProjectsSchemasGetCall
- func (r *ProjectsSchemasService) GetIamPolicy(resource string) *ProjectsSchemasGetIamPolicyCall
- func (r *ProjectsSchemasService) List(parent string) *ProjectsSchemasListCall
- func (r *ProjectsSchemasService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsSchemasSetIamPolicyCall
- func (r *ProjectsSchemasService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsSchemasTestIamPermissionsCall
- func (r *ProjectsSchemasService) Validate(parent string, validateschemarequest *ValidateSchemaRequest) *ProjectsSchemasValidateCall
- func (r *ProjectsSchemasService) ValidateMessage(parent string, validatemessagerequest *ValidateMessageRequest) *ProjectsSchemasValidateMessageCall
- type ProjectsSchemasSetIamPolicyCall
- func (c *ProjectsSchemasSetIamPolicyCall) Context(ctx context.Context) *ProjectsSchemasSetIamPolicyCall
- func (c *ProjectsSchemasSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
- func (c *ProjectsSchemasSetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsSchemasSetIamPolicyCall
- func (c *ProjectsSchemasSetIamPolicyCall) Header() http.Header
- type ProjectsSchemasTestIamPermissionsCall
- func (c *ProjectsSchemasTestIamPermissionsCall) Context(ctx context.Context) *ProjectsSchemasTestIamPermissionsCall
- func (c *ProjectsSchemasTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)
- func (c *ProjectsSchemasTestIamPermissionsCall) Fields(s ...googleapi.Field) *ProjectsSchemasTestIamPermissionsCall
- func (c *ProjectsSchemasTestIamPermissionsCall) Header() http.Header
- type ProjectsSchemasValidateCall
- func (c *ProjectsSchemasValidateCall) Context(ctx context.Context) *ProjectsSchemasValidateCall
- func (c *ProjectsSchemasValidateCall) Do(opts ...googleapi.CallOption) (*ValidateSchemaResponse, error)
- func (c *ProjectsSchemasValidateCall) Fields(s ...googleapi.Field) *ProjectsSchemasValidateCall
- func (c *ProjectsSchemasValidateCall) Header() http.Header
- type ProjectsSchemasValidateMessageCall
- func (c *ProjectsSchemasValidateMessageCall) Context(ctx context.Context) *ProjectsSchemasValidateMessageCall
- func (c *ProjectsSchemasValidateMessageCall) Do(opts ...googleapi.CallOption) (*ValidateMessageResponse, error)
- func (c *ProjectsSchemasValidateMessageCall) Fields(s ...googleapi.Field) *ProjectsSchemasValidateMessageCall
- func (c *ProjectsSchemasValidateMessageCall) Header() http.Header
- type ProjectsService
- type ProjectsSnapshotsCreateCall
- func (c *ProjectsSnapshotsCreateCall) Context(ctx context.Context) *ProjectsSnapshotsCreateCall
- func (c *ProjectsSnapshotsCreateCall) Do(opts ...googleapi.CallOption) (*Snapshot, error)
- func (c *ProjectsSnapshotsCreateCall) Fields(s ...googleapi.Field) *ProjectsSnapshotsCreateCall
- func (c *ProjectsSnapshotsCreateCall) Header() http.Header
- type ProjectsSnapshotsDeleteCall
- func (c *ProjectsSnapshotsDeleteCall) Context(ctx context.Context) *ProjectsSnapshotsDeleteCall
- func (c *ProjectsSnapshotsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *ProjectsSnapshotsDeleteCall) Fields(s ...googleapi.Field) *ProjectsSnapshotsDeleteCall
- func (c *ProjectsSnapshotsDeleteCall) Header() http.Header
- type ProjectsSnapshotsGetCall
- func (c *ProjectsSnapshotsGetCall) Context(ctx context.Context) *ProjectsSnapshotsGetCall
- func (c *ProjectsSnapshotsGetCall) Do(opts ...googleapi.CallOption) (*Snapshot, error)
- func (c *ProjectsSnapshotsGetCall) Fields(s ...googleapi.Field) *ProjectsSnapshotsGetCall
- func (c *ProjectsSnapshotsGetCall) Header() http.Header
- func (c *ProjectsSnapshotsGetCall) IfNoneMatch(entityTag string) *ProjectsSnapshotsGetCall
- type ProjectsSnapshotsGetIamPolicyCall
- func (c *ProjectsSnapshotsGetIamPolicyCall) Context(ctx context.Context) *ProjectsSnapshotsGetIamPolicyCall
- func (c *ProjectsSnapshotsGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
- func (c *ProjectsSnapshotsGetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsSnapshotsGetIamPolicyCall
- func (c *ProjectsSnapshotsGetIamPolicyCall) Header() http.Header
- func (c *ProjectsSnapshotsGetIamPolicyCall) IfNoneMatch(entityTag string) *ProjectsSnapshotsGetIamPolicyCall
- func (c *ProjectsSnapshotsGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsSnapshotsGetIamPolicyCall
- type ProjectsSnapshotsListCall
- func (c *ProjectsSnapshotsListCall) Context(ctx context.Context) *ProjectsSnapshotsListCall
- func (c *ProjectsSnapshotsListCall) Do(opts ...googleapi.CallOption) (*ListSnapshotsResponse, error)
- func (c *ProjectsSnapshotsListCall) Fields(s ...googleapi.Field) *ProjectsSnapshotsListCall
- func (c *ProjectsSnapshotsListCall) Header() http.Header
- func (c *ProjectsSnapshotsListCall) IfNoneMatch(entityTag string) *ProjectsSnapshotsListCall
- func (c *ProjectsSnapshotsListCall) PageSize(pageSize int64) *ProjectsSnapshotsListCall
- func (c *ProjectsSnapshotsListCall) PageToken(pageToken string) *ProjectsSnapshotsListCall
- func (c *ProjectsSnapshotsListCall) Pages(ctx context.Context, f func(*ListSnapshotsResponse) error) error
- type ProjectsSnapshotsPatchCall
- func (c *ProjectsSnapshotsPatchCall) Context(ctx context.Context) *ProjectsSnapshotsPatchCall
- func (c *ProjectsSnapshotsPatchCall) Do(opts ...googleapi.CallOption) (*Snapshot, error)
- func (c *ProjectsSnapshotsPatchCall) Fields(s ...googleapi.Field) *ProjectsSnapshotsPatchCall
- func (c *ProjectsSnapshotsPatchCall) Header() http.Header
- type ProjectsSnapshotsService
- func (r *ProjectsSnapshotsService) Create(name string, createsnapshotrequest *CreateSnapshotRequest) *ProjectsSnapshotsCreateCall
- func (r *ProjectsSnapshotsService) Delete(snapshot string) *ProjectsSnapshotsDeleteCall
- func (r *ProjectsSnapshotsService) Get(snapshot string) *ProjectsSnapshotsGetCall
- func (r *ProjectsSnapshotsService) GetIamPolicy(resource string) *ProjectsSnapshotsGetIamPolicyCall
- func (r *ProjectsSnapshotsService) List(project string) *ProjectsSnapshotsListCall
- func (r *ProjectsSnapshotsService) Patch(name string, updatesnapshotrequest *UpdateSnapshotRequest) *ProjectsSnapshotsPatchCall
- func (r *ProjectsSnapshotsService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsSnapshotsSetIamPolicyCall
- func (r *ProjectsSnapshotsService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsSnapshotsTestIamPermissionsCall
- type ProjectsSnapshotsSetIamPolicyCall
- func (c *ProjectsSnapshotsSetIamPolicyCall) Context(ctx context.Context) *ProjectsSnapshotsSetIamPolicyCall
- func (c *ProjectsSnapshotsSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
- func (c *ProjectsSnapshotsSetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsSnapshotsSetIamPolicyCall
- func (c *ProjectsSnapshotsSetIamPolicyCall) Header() http.Header
- type ProjectsSnapshotsTestIamPermissionsCall
- func (c *ProjectsSnapshotsTestIamPermissionsCall) Context(ctx context.Context) *ProjectsSnapshotsTestIamPermissionsCall
- func (c *ProjectsSnapshotsTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)
- func (c *ProjectsSnapshotsTestIamPermissionsCall) Fields(s ...googleapi.Field) *ProjectsSnapshotsTestIamPermissionsCall
- func (c *ProjectsSnapshotsTestIamPermissionsCall) Header() http.Header
- type ProjectsSubscriptionsAcknowledgeCall
- func (c *ProjectsSubscriptionsAcknowledgeCall) Context(ctx context.Context) *ProjectsSubscriptionsAcknowledgeCall
- func (c *ProjectsSubscriptionsAcknowledgeCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *ProjectsSubscriptionsAcknowledgeCall) Fields(s ...googleapi.Field) *ProjectsSubscriptionsAcknowledgeCall
- func (c *ProjectsSubscriptionsAcknowledgeCall) Header() http.Header
- type ProjectsSubscriptionsCreateCall
- func (c *ProjectsSubscriptionsCreateCall) Context(ctx context.Context) *ProjectsSubscriptionsCreateCall
- func (c *ProjectsSubscriptionsCreateCall) Do(opts ...googleapi.CallOption) (*Subscription, error)
- func (c *ProjectsSubscriptionsCreateCall) Fields(s ...googleapi.Field) *ProjectsSubscriptionsCreateCall
- func (c *ProjectsSubscriptionsCreateCall) Header() http.Header
- type ProjectsSubscriptionsDeleteCall
- func (c *ProjectsSubscriptionsDeleteCall) Context(ctx context.Context) *ProjectsSubscriptionsDeleteCall
- func (c *ProjectsSubscriptionsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *ProjectsSubscriptionsDeleteCall) Fields(s ...googleapi.Field) *ProjectsSubscriptionsDeleteCall
- func (c *ProjectsSubscriptionsDeleteCall) Header() http.Header
- type ProjectsSubscriptionsDetachCall
- func (c *ProjectsSubscriptionsDetachCall) Context(ctx context.Context) *ProjectsSubscriptionsDetachCall
- func (c *ProjectsSubscriptionsDetachCall) Do(opts ...googleapi.CallOption) (*DetachSubscriptionResponse, error)
- func (c *ProjectsSubscriptionsDetachCall) Fields(s ...googleapi.Field) *ProjectsSubscriptionsDetachCall
- func (c *ProjectsSubscriptionsDetachCall) Header() http.Header
- type ProjectsSubscriptionsGetCall
- func (c *ProjectsSubscriptionsGetCall) Context(ctx context.Context) *ProjectsSubscriptionsGetCall
- func (c *ProjectsSubscriptionsGetCall) Do(opts ...googleapi.CallOption) (*Subscription, error)
- func (c *ProjectsSubscriptionsGetCall) Fields(s ...googleapi.Field) *ProjectsSubscriptionsGetCall
- func (c *ProjectsSubscriptionsGetCall) Header() http.Header
- func (c *ProjectsSubscriptionsGetCall) IfNoneMatch(entityTag string) *ProjectsSubscriptionsGetCall
- type ProjectsSubscriptionsGetIamPolicyCall
- func (c *ProjectsSubscriptionsGetIamPolicyCall) Context(ctx context.Context) *ProjectsSubscriptionsGetIamPolicyCall
- func (c *ProjectsSubscriptionsGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
- func (c *ProjectsSubscriptionsGetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsSubscriptionsGetIamPolicyCall
- func (c *ProjectsSubscriptionsGetIamPolicyCall) Header() http.Header
- func (c *ProjectsSubscriptionsGetIamPolicyCall) IfNoneMatch(entityTag string) *ProjectsSubscriptionsGetIamPolicyCall
- func (c *ProjectsSubscriptionsGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsSubscriptionsGetIamPolicyCall
- type ProjectsSubscriptionsListCall
- func (c *ProjectsSubscriptionsListCall) Context(ctx context.Context) *ProjectsSubscriptionsListCall
- func (c *ProjectsSubscriptionsListCall) Do(opts ...googleapi.CallOption) (*ListSubscriptionsResponse, error)
- func (c *ProjectsSubscriptionsListCall) Fields(s ...googleapi.Field) *ProjectsSubscriptionsListCall
- func (c *ProjectsSubscriptionsListCall) Header() http.Header
- func (c *ProjectsSubscriptionsListCall) IfNoneMatch(entityTag string) *ProjectsSubscriptionsListCall
- func (c *ProjectsSubscriptionsListCall) PageSize(pageSize int64) *ProjectsSubscriptionsListCall
- func (c *ProjectsSubscriptionsListCall) PageToken(pageToken string) *ProjectsSubscriptionsListCall
- func (c *ProjectsSubscriptionsListCall) Pages(ctx context.Context, f func(*ListSubscriptionsResponse) error) error
- type ProjectsSubscriptionsModifyAckDeadlineCall
- func (c *ProjectsSubscriptionsModifyAckDeadlineCall) Context(ctx context.Context) *ProjectsSubscriptionsModifyAckDeadlineCall
- func (c *ProjectsSubscriptionsModifyAckDeadlineCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *ProjectsSubscriptionsModifyAckDeadlineCall) Fields(s ...googleapi.Field) *ProjectsSubscriptionsModifyAckDeadlineCall
- func (c *ProjectsSubscriptionsModifyAckDeadlineCall) Header() http.Header
- type ProjectsSubscriptionsModifyPushConfigCall
- func (c *ProjectsSubscriptionsModifyPushConfigCall) Context(ctx context.Context) *ProjectsSubscriptionsModifyPushConfigCall
- func (c *ProjectsSubscriptionsModifyPushConfigCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *ProjectsSubscriptionsModifyPushConfigCall) Fields(s ...googleapi.Field) *ProjectsSubscriptionsModifyPushConfigCall
- func (c *ProjectsSubscriptionsModifyPushConfigCall) Header() http.Header
- type ProjectsSubscriptionsPatchCall
- func (c *ProjectsSubscriptionsPatchCall) Context(ctx context.Context) *ProjectsSubscriptionsPatchCall
- func (c *ProjectsSubscriptionsPatchCall) Do(opts ...googleapi.CallOption) (*Subscription, error)
- func (c *ProjectsSubscriptionsPatchCall) Fields(s ...googleapi.Field) *ProjectsSubscriptionsPatchCall
- func (c *ProjectsSubscriptionsPatchCall) Header() http.Header
- type ProjectsSubscriptionsPullCall
- func (c *ProjectsSubscriptionsPullCall) Context(ctx context.Context) *ProjectsSubscriptionsPullCall
- func (c *ProjectsSubscriptionsPullCall) Do(opts ...googleapi.CallOption) (*PullResponse, error)
- func (c *ProjectsSubscriptionsPullCall) Fields(s ...googleapi.Field) *ProjectsSubscriptionsPullCall
- func (c *ProjectsSubscriptionsPullCall) Header() http.Header
- type ProjectsSubscriptionsSeekCall
- func (c *ProjectsSubscriptionsSeekCall) Context(ctx context.Context) *ProjectsSubscriptionsSeekCall
- func (c *ProjectsSubscriptionsSeekCall) Do(opts ...googleapi.CallOption) (*SeekResponse, error)
- func (c *ProjectsSubscriptionsSeekCall) Fields(s ...googleapi.Field) *ProjectsSubscriptionsSeekCall
- func (c *ProjectsSubscriptionsSeekCall) Header() http.Header
- type ProjectsSubscriptionsService
- func (r *ProjectsSubscriptionsService) Acknowledge(subscription string, acknowledgerequest *AcknowledgeRequest) *ProjectsSubscriptionsAcknowledgeCall
- func (r *ProjectsSubscriptionsService) Create(name string, subscription *Subscription) *ProjectsSubscriptionsCreateCall
- func (r *ProjectsSubscriptionsService) Delete(subscription string) *ProjectsSubscriptionsDeleteCall
- func (r *ProjectsSubscriptionsService) Detach(subscription string) *ProjectsSubscriptionsDetachCall
- func (r *ProjectsSubscriptionsService) Get(subscription string) *ProjectsSubscriptionsGetCall
- func (r *ProjectsSubscriptionsService) GetIamPolicy(resource string) *ProjectsSubscriptionsGetIamPolicyCall
- func (r *ProjectsSubscriptionsService) List(project string) *ProjectsSubscriptionsListCall
- func (r *ProjectsSubscriptionsService) ModifyAckDeadline(subscription string, modifyackdeadlinerequest *ModifyAckDeadlineRequest) *ProjectsSubscriptionsModifyAckDeadlineCall
- func (r *ProjectsSubscriptionsService) ModifyPushConfig(subscription string, modifypushconfigrequest *ModifyPushConfigRequest) *ProjectsSubscriptionsModifyPushConfigCall
- func (r *ProjectsSubscriptionsService) Patch(name string, updatesubscriptionrequest *UpdateSubscriptionRequest) *ProjectsSubscriptionsPatchCall
- func (r *ProjectsSubscriptionsService) Pull(subscription string, pullrequest *PullRequest) *ProjectsSubscriptionsPullCall
- func (r *ProjectsSubscriptionsService) Seek(subscription string, seekrequest *SeekRequest) *ProjectsSubscriptionsSeekCall
- func (r *ProjectsSubscriptionsService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsSubscriptionsSetIamPolicyCall
- func (r *ProjectsSubscriptionsService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsSubscriptionsTestIamPermissionsCall
- type ProjectsSubscriptionsSetIamPolicyCall
- func (c *ProjectsSubscriptionsSetIamPolicyCall) Context(ctx context.Context) *ProjectsSubscriptionsSetIamPolicyCall
- func (c *ProjectsSubscriptionsSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
- func (c *ProjectsSubscriptionsSetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsSubscriptionsSetIamPolicyCall
- func (c *ProjectsSubscriptionsSetIamPolicyCall) Header() http.Header
- type ProjectsSubscriptionsTestIamPermissionsCall
- func (c *ProjectsSubscriptionsTestIamPermissionsCall) Context(ctx context.Context) *ProjectsSubscriptionsTestIamPermissionsCall
- func (c *ProjectsSubscriptionsTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)
- func (c *ProjectsSubscriptionsTestIamPermissionsCall) Fields(s ...googleapi.Field) *ProjectsSubscriptionsTestIamPermissionsCall
- func (c *ProjectsSubscriptionsTestIamPermissionsCall) Header() http.Header
- type ProjectsTopicsCreateCall
- func (c *ProjectsTopicsCreateCall) Context(ctx context.Context) *ProjectsTopicsCreateCall
- func (c *ProjectsTopicsCreateCall) Do(opts ...googleapi.CallOption) (*Topic, error)
- func (c *ProjectsTopicsCreateCall) Fields(s ...googleapi.Field) *ProjectsTopicsCreateCall
- func (c *ProjectsTopicsCreateCall) Header() http.Header
- type ProjectsTopicsDeleteCall
- func (c *ProjectsTopicsDeleteCall) Context(ctx context.Context) *ProjectsTopicsDeleteCall
- func (c *ProjectsTopicsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
- func (c *ProjectsTopicsDeleteCall) Fields(s ...googleapi.Field) *ProjectsTopicsDeleteCall
- func (c *ProjectsTopicsDeleteCall) Header() http.Header
- type ProjectsTopicsGetCall
- func (c *ProjectsTopicsGetCall) Context(ctx context.Context) *ProjectsTopicsGetCall
- func (c *ProjectsTopicsGetCall) Do(opts ...googleapi.CallOption) (*Topic, error)
- func (c *ProjectsTopicsGetCall) Fields(s ...googleapi.Field) *ProjectsTopicsGetCall
- func (c *ProjectsTopicsGetCall) Header() http.Header
- func (c *ProjectsTopicsGetCall) IfNoneMatch(entityTag string) *ProjectsTopicsGetCall
- type ProjectsTopicsGetIamPolicyCall
- func (c *ProjectsTopicsGetIamPolicyCall) Context(ctx context.Context) *ProjectsTopicsGetIamPolicyCall
- func (c *ProjectsTopicsGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
- func (c *ProjectsTopicsGetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsTopicsGetIamPolicyCall
- func (c *ProjectsTopicsGetIamPolicyCall) Header() http.Header
- func (c *ProjectsTopicsGetIamPolicyCall) IfNoneMatch(entityTag string) *ProjectsTopicsGetIamPolicyCall
- func (c *ProjectsTopicsGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsTopicsGetIamPolicyCall
- type ProjectsTopicsListCall
- func (c *ProjectsTopicsListCall) Context(ctx context.Context) *ProjectsTopicsListCall
- func (c *ProjectsTopicsListCall) Do(opts ...googleapi.CallOption) (*ListTopicsResponse, error)
- func (c *ProjectsTopicsListCall) Fields(s ...googleapi.Field) *ProjectsTopicsListCall
- func (c *ProjectsTopicsListCall) Header() http.Header
- func (c *ProjectsTopicsListCall) IfNoneMatch(entityTag string) *ProjectsTopicsListCall
- func (c *ProjectsTopicsListCall) PageSize(pageSize int64) *ProjectsTopicsListCall
- func (c *ProjectsTopicsListCall) PageToken(pageToken string) *ProjectsTopicsListCall
- func (c *ProjectsTopicsListCall) Pages(ctx context.Context, f func(*ListTopicsResponse) error) error
- type ProjectsTopicsPatchCall
- func (c *ProjectsTopicsPatchCall) Context(ctx context.Context) *ProjectsTopicsPatchCall
- func (c *ProjectsTopicsPatchCall) Do(opts ...googleapi.CallOption) (*Topic, error)
- func (c *ProjectsTopicsPatchCall) Fields(s ...googleapi.Field) *ProjectsTopicsPatchCall
- func (c *ProjectsTopicsPatchCall) Header() http.Header
- type ProjectsTopicsPublishCall
- func (c *ProjectsTopicsPublishCall) Context(ctx context.Context) *ProjectsTopicsPublishCall
- func (c *ProjectsTopicsPublishCall) Do(opts ...googleapi.CallOption) (*PublishResponse, error)
- func (c *ProjectsTopicsPublishCall) Fields(s ...googleapi.Field) *ProjectsTopicsPublishCall
- func (c *ProjectsTopicsPublishCall) Header() http.Header
- type ProjectsTopicsService
- func (r *ProjectsTopicsService) Create(name string, topic *Topic) *ProjectsTopicsCreateCall
- func (r *ProjectsTopicsService) Delete(topic string) *ProjectsTopicsDeleteCall
- func (r *ProjectsTopicsService) Get(topic string) *ProjectsTopicsGetCall
- func (r *ProjectsTopicsService) GetIamPolicy(resource string) *ProjectsTopicsGetIamPolicyCall
- func (r *ProjectsTopicsService) List(project string) *ProjectsTopicsListCall
- func (r *ProjectsTopicsService) Patch(name string, updatetopicrequest *UpdateTopicRequest) *ProjectsTopicsPatchCall
- func (r *ProjectsTopicsService) Publish(topic string, publishrequest *PublishRequest) *ProjectsTopicsPublishCall
- func (r *ProjectsTopicsService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsTopicsSetIamPolicyCall
- func (r *ProjectsTopicsService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsTopicsTestIamPermissionsCall
- type ProjectsTopicsSetIamPolicyCall
- func (c *ProjectsTopicsSetIamPolicyCall) Context(ctx context.Context) *ProjectsTopicsSetIamPolicyCall
- func (c *ProjectsTopicsSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
- func (c *ProjectsTopicsSetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsTopicsSetIamPolicyCall
- func (c *ProjectsTopicsSetIamPolicyCall) Header() http.Header
- type ProjectsTopicsSnapshotsListCall
- func (c *ProjectsTopicsSnapshotsListCall) Context(ctx context.Context) *ProjectsTopicsSnapshotsListCall
- func (c *ProjectsTopicsSnapshotsListCall) Do(opts ...googleapi.CallOption) (*ListTopicSnapshotsResponse, error)
- func (c *ProjectsTopicsSnapshotsListCall) Fields(s ...googleapi.Field) *ProjectsTopicsSnapshotsListCall
- func (c *ProjectsTopicsSnapshotsListCall) Header() http.Header
- func (c *ProjectsTopicsSnapshotsListCall) IfNoneMatch(entityTag string) *ProjectsTopicsSnapshotsListCall
- func (c *ProjectsTopicsSnapshotsListCall) PageSize(pageSize int64) *ProjectsTopicsSnapshotsListCall
- func (c *ProjectsTopicsSnapshotsListCall) PageToken(pageToken string) *ProjectsTopicsSnapshotsListCall
- func (c *ProjectsTopicsSnapshotsListCall) Pages(ctx context.Context, f func(*ListTopicSnapshotsResponse) error) error
- type ProjectsTopicsSnapshotsService
- type ProjectsTopicsSubscriptionsListCall
- func (c *ProjectsTopicsSubscriptionsListCall) Context(ctx context.Context) *ProjectsTopicsSubscriptionsListCall
- func (c *ProjectsTopicsSubscriptionsListCall) Do(opts ...googleapi.CallOption) (*ListTopicSubscriptionsResponse, error)
- func (c *ProjectsTopicsSubscriptionsListCall) Fields(s ...googleapi.Field) *ProjectsTopicsSubscriptionsListCall
- func (c *ProjectsTopicsSubscriptionsListCall) Header() http.Header
- func (c *ProjectsTopicsSubscriptionsListCall) IfNoneMatch(entityTag string) *ProjectsTopicsSubscriptionsListCall
- func (c *ProjectsTopicsSubscriptionsListCall) PageSize(pageSize int64) *ProjectsTopicsSubscriptionsListCall
- func (c *ProjectsTopicsSubscriptionsListCall) PageToken(pageToken string) *ProjectsTopicsSubscriptionsListCall
- func (c *ProjectsTopicsSubscriptionsListCall) Pages(ctx context.Context, f func(*ListTopicSubscriptionsResponse) error) error
- type ProjectsTopicsSubscriptionsService
- type ProjectsTopicsTestIamPermissionsCall
- func (c *ProjectsTopicsTestIamPermissionsCall) Context(ctx context.Context) *ProjectsTopicsTestIamPermissionsCall
- func (c *ProjectsTopicsTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)
- func (c *ProjectsTopicsTestIamPermissionsCall) Fields(s ...googleapi.Field) *ProjectsTopicsTestIamPermissionsCall
- func (c *ProjectsTopicsTestIamPermissionsCall) Header() http.Header
- type PublishRequest
- type PublishResponse
- type PubsubMessage
- type PullRequest
- type PullResponse
- type PushConfig
- type ReceivedMessage
- type RetryPolicy
- type Schema
- type SchemaSettings
- type SeekRequest
- type SeekResponse
- type Service
- type SetIamPolicyRequest
- type Snapshot
- type Subscription
- type TestIamPermissionsRequest
- type TestIamPermissionsResponse
- type Topic
- type UpdateSnapshotRequest
- type UpdateSubscriptionRequest
- type UpdateTopicRequest
- type ValidateMessageRequest
- type ValidateMessageResponse
- type ValidateSchemaRequest
- type ValidateSchemaResponse
Constants ¶
const ( // View and manage your data across Google Cloud Platform services CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform" // View and manage Pub/Sub topics and subscriptions PubsubScope = "https://www.googleapis.com/auth/pubsub" )
OAuth2 scopes used by this API.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AcknowledgeRequest ¶
type AcknowledgeRequest struct { // AckIds: Required. 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 ¶
func (s *AcknowledgeRequest) MarshalJSON() ([]byte, error)
type Binding ¶
type Binding struct { // Condition: The condition that is associated with this binding. If the // condition evaluates to `true`, then this binding applies to the // current request. If the condition evaluates to `false`, then this // binding does not apply to the current request. However, a different // role binding might grant the same role to one or more of the members // in this binding. To learn which resources support conditions in their // IAM policies, see the IAM documentation // (https://cloud.google.com/iam/help/conditions/resource-policies). 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@example.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`. * `deleted:user:{emailid}?uid={uniqueid}`: An // email address (plus unique identifier) representing a user that has // been recently deleted. For example, // `alice@example.com?uid=123456789012345678901`. If the user is // recovered, this value reverts to `user:{emailid}` and the recovered // user retains the role in the binding. * // `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address // (plus unique identifier) representing a service account that has been // recently deleted. For example, // `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. // If the service account is undeleted, this value reverts to // `serviceAccount:{emailid}` and the undeleted service account retains // the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: // An email address (plus unique identifier) representing a Google group // that has been recently deleted. For example, // `admins@example.com?uid=123456789012345678901`. If the group is // recovered, this value reverts to `group:{emailid}` and the recovered // group retains the role in the binding. * `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 ¶
type CreateSnapshotRequest ¶
type CreateSnapshotRequest struct { // Labels: See Creating and managing labels. Labels map[string]string `json:"labels,omitempty"` // Subscription: Required. 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 ¶
func (s *CreateSnapshotRequest) MarshalJSON() ([]byte, error)
type DeadLetterPolicy ¶ added in v0.16.0
type DeadLetterPolicy struct { // DeadLetterTopic: The name of the topic to which dead letter messages // should be published. Format is // `projects/{project}/topics/{topic}`.The Cloud Pub/Sub service account // associated with the enclosing subscription's parent project (i.e., // service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must // have permission to Publish() to this topic. The operation will fail // if the topic does not exist. Users should ensure that there is a // subscription attached to this topic since messages published to a // topic with no subscriptions are lost. DeadLetterTopic string `json:"deadLetterTopic,omitempty"` // MaxDeliveryAttempts: The maximum number of delivery attempts for any // message. The value must be between 5 and 100. The number of delivery // attempts is defined as 1 + (the sum of number of NACKs and number of // times the acknowledgement deadline has been exceeded for the // message). A NACK is any call to ModifyAckDeadline with a 0 deadline. // Note that client libraries may automatically extend ack_deadlines. // This field will be honored on a best effort basis. If this parameter // is 0, a default value of 5 is used. MaxDeliveryAttempts int64 `json:"maxDeliveryAttempts,omitempty"` // ForceSendFields is a list of field names (e.g. "DeadLetterTopic") 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. "DeadLetterTopic") 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:"-"` }
DeadLetterPolicy: Dead lettering is done on a best effort basis. The same message might be dead lettered multiple times. If validation on any of the fields fails at subscription creation/updation, the create/update subscription request will fail.
func (*DeadLetterPolicy) MarshalJSON ¶ added in v0.16.0
func (s *DeadLetterPolicy) MarshalJSON() ([]byte, error)
type DetachSubscriptionResponse ¶ added in v0.27.0
type DetachSubscriptionResponse struct { // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` }
DetachSubscriptionResponse: Response for the DetachSubscription method. Reserved for future use.
type Empty ¶
type Empty struct { // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` }
Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
type ExpirationPolicy ¶
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 ¶
func (s *ExpirationPolicy) MarshalJSON() ([]byte, error)
type Expr ¶
type Expr struct { // Description: 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. Expression string `json:"expression,omitempty"` // Location: 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: 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 a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
func (*Expr) MarshalJSON ¶
type ListSchemasResponse ¶ added in v0.41.0
type ListSchemasResponse struct { // NextPageToken: If not empty, indicates that there may be more schemas // that match the request; this value should be passed in a new // `ListSchemasRequest`. NextPageToken string `json:"nextPageToken,omitempty"` // Schemas: The resulting schemas. Schemas []*Schema `json:"schemas,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:"-"` }
ListSchemasResponse: Response for the `ListSchemas` method.
func (*ListSchemasResponse) MarshalJSON ¶ added in v0.41.0
func (s *ListSchemasResponse) MarshalJSON() ([]byte, error)
type ListSnapshotsResponse ¶
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 ¶
func (s *ListSnapshotsResponse) MarshalJSON() ([]byte, error)
type ListSubscriptionsResponse ¶
type ListSubscriptionsResponse struct { // NextPageToken: If not empty, indicates that there may be more // subscriptions that match the request; this value should be passed in // a new `ListSubscriptionsRequest` to get more subscriptions. NextPageToken string `json:"nextPageToken,omitempty"` // Subscriptions: The subscriptions that match the request. Subscriptions []*Subscription `json:"subscriptions,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "NextPageToken") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "NextPageToken") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ListSubscriptionsResponse: Response for the `ListSubscriptions` method.
func (*ListSubscriptionsResponse) MarshalJSON ¶
func (s *ListSubscriptionsResponse) MarshalJSON() ([]byte, error)
type ListTopicSnapshotsResponse ¶
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 ¶
func (s *ListTopicSnapshotsResponse) MarshalJSON() ([]byte, error)
type ListTopicSubscriptionsResponse ¶
type ListTopicSubscriptionsResponse struct { // NextPageToken: If not empty, indicates that there may be more // subscriptions that match the request; this value should be passed in // a new `ListTopicSubscriptionsRequest` to get more subscriptions. NextPageToken string `json:"nextPageToken,omitempty"` // Subscriptions: The names of subscriptions attached to the topic // specified in 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 ¶
func (s *ListTopicSubscriptionsResponse) MarshalJSON() ([]byte, error)
type ListTopicsResponse ¶
type ListTopicsResponse struct { // NextPageToken: If not empty, indicates that there may be more topics // that match the request; this value should be passed in a new // `ListTopicsRequest`. NextPageToken string `json:"nextPageToken,omitempty"` // Topics: The resulting topics. Topics []*Topic `json:"topics,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "NextPageToken") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the // server regardless of whether the field is empty or not. This may be // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` // NullFields is a list of field names (e.g. "NextPageToken") to include // in API requests with the JSON null value. By default, fields with // empty values are omitted from API requests. However, any field with // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` }
ListTopicsResponse: Response for the `ListTopics` method.
func (*ListTopicsResponse) MarshalJSON ¶
func (s *ListTopicsResponse) MarshalJSON() ([]byte, error)
type MessageStoragePolicy ¶ added in v0.7.0
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:"-"` }
MessageStoragePolicy: A policy constraining the storage of messages published to the topic.
func (*MessageStoragePolicy) MarshalJSON ¶ added in v0.7.0
func (s *MessageStoragePolicy) MarshalJSON() ([]byte, error)
type ModifyAckDeadlineRequest ¶
type ModifyAckDeadlineRequest struct { // AckDeadlineSeconds: Required. 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: Required. 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 ¶
func (s *ModifyAckDeadlineRequest) MarshalJSON() ([]byte, error)
type ModifyPushConfigRequest ¶
type ModifyPushConfigRequest struct { // PushConfig: Required. 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 ¶
func (s *ModifyPushConfigRequest) MarshalJSON() ([]byte, error)
type OidcToken ¶ added in v0.3.0
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/OpenIDConnect).
func (*OidcToken) MarshalJSON ¶ added in v0.3.0
type Policy ¶
type Policy struct { // Bindings: Associates a list of `members` to a `role`. Optionally, may // specify a `condition` that determines how and when the `bindings` are // applied. Each of the `bindings` must contain at least one member. 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. **Important:** If you use IAM // Conditions, you must include the `etag` field whenever you call // `setIamPolicy`. If you omit this field, then IAM allows you to // overwrite a version `3` policy with a version `1` policy, and all of // the conditions in the version `3` policy are lost. Etag string `json:"etag,omitempty"` // Version: Specifies the format of the policy. Valid values are `0`, // `1`, and `3`. Requests that specify an invalid value are rejected. // Any operation that affects conditional role bindings must specify // version `3`. This requirement applies to the following operations: * // Getting a policy that includes a conditional role binding * Adding a // conditional role binding to a policy * Changing a conditional role // binding in a policy * Removing any role binding, with or without a // condition, from a policy that includes conditions **Important:** If // you use IAM Conditions, you must include the `etag` field whenever // you call `setIamPolicy`. If you omit this field, then IAM allows you // to overwrite a version `3` policy with a version `1` policy, and all // of the conditions in the version `3` policy are lost. If a policy // does not include any conditions, operations on that policy may // specify any valid version or leave the field unset. To learn which // resources support conditions in their IAM policies, see the IAM // documentation // (https://cloud.google.com/iam/help/conditions/resource-policies). 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: An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
func (*Policy) MarshalJSON ¶
type ProjectsSchemasCreateCall ¶ added in v0.41.0
type ProjectsSchemasCreateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSchemasCreateCall) Context ¶ added in v0.41.0
func (c *ProjectsSchemasCreateCall) Context(ctx context.Context) *ProjectsSchemasCreateCall
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 (*ProjectsSchemasCreateCall) Do ¶ added in v0.41.0
func (c *ProjectsSchemasCreateCall) Do(opts ...googleapi.CallOption) (*Schema, error)
Do executes the "pubsub.projects.schemas.create" call. Exactly one of *Schema or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Schema.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 (*ProjectsSchemasCreateCall) Fields ¶ added in v0.41.0
func (c *ProjectsSchemasCreateCall) Fields(s ...googleapi.Field) *ProjectsSchemasCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsSchemasCreateCall) Header ¶ added in v0.41.0
func (c *ProjectsSchemasCreateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsSchemasCreateCall) SchemaId ¶ added in v0.41.0
func (c *ProjectsSchemasCreateCall) SchemaId(schemaId string) *ProjectsSchemasCreateCall
SchemaId sets the optional parameter "schemaId": The ID to use for the schema, which will become the final component of the schema's resource name. See https://cloud.google.com/pubsub/docs/admin#resource_names for resource name constraints.
type ProjectsSchemasDeleteCall ¶ added in v0.41.0
type ProjectsSchemasDeleteCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSchemasDeleteCall) Context ¶ added in v0.41.0
func (c *ProjectsSchemasDeleteCall) Context(ctx context.Context) *ProjectsSchemasDeleteCall
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 (*ProjectsSchemasDeleteCall) Do ¶ added in v0.41.0
func (c *ProjectsSchemasDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)
Do executes the "pubsub.projects.schemas.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 (*ProjectsSchemasDeleteCall) Fields ¶ added in v0.41.0
func (c *ProjectsSchemasDeleteCall) Fields(s ...googleapi.Field) *ProjectsSchemasDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsSchemasDeleteCall) Header ¶ added in v0.41.0
func (c *ProjectsSchemasDeleteCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsSchemasGetCall ¶ added in v0.41.0
type ProjectsSchemasGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSchemasGetCall) Context ¶ added in v0.41.0
func (c *ProjectsSchemasGetCall) Context(ctx context.Context) *ProjectsSchemasGetCall
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 (*ProjectsSchemasGetCall) Do ¶ added in v0.41.0
func (c *ProjectsSchemasGetCall) Do(opts ...googleapi.CallOption) (*Schema, error)
Do executes the "pubsub.projects.schemas.get" call. Exactly one of *Schema or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Schema.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 (*ProjectsSchemasGetCall) Fields ¶ added in v0.41.0
func (c *ProjectsSchemasGetCall) Fields(s ...googleapi.Field) *ProjectsSchemasGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsSchemasGetCall) Header ¶ added in v0.41.0
func (c *ProjectsSchemasGetCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsSchemasGetCall) IfNoneMatch ¶ added in v0.41.0
func (c *ProjectsSchemasGetCall) IfNoneMatch(entityTag string) *ProjectsSchemasGetCall
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 (*ProjectsSchemasGetCall) View ¶ added in v0.41.0
func (c *ProjectsSchemasGetCall) View(view string) *ProjectsSchemasGetCall
View sets the optional parameter "view": The set of fields to return in the response. If not set, returns a Schema with `name` and `type`, but not `definition`. Set to `FULL` to retrieve all fields.
Possible values:
"SCHEMA_VIEW_UNSPECIFIED" - The default / unset value. The API will
default to the BASIC view.
"BASIC" - Include the name and type of the schema, but not the
definition.
"FULL" - Include all Schema object fields.
type ProjectsSchemasGetIamPolicyCall ¶ added in v0.41.0
type ProjectsSchemasGetIamPolicyCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSchemasGetIamPolicyCall) Context ¶ added in v0.41.0
func (c *ProjectsSchemasGetIamPolicyCall) Context(ctx context.Context) *ProjectsSchemasGetIamPolicyCall
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 (*ProjectsSchemasGetIamPolicyCall) Do ¶ added in v0.41.0
func (c *ProjectsSchemasGetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
Do executes the "pubsub.projects.schemas.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 (*ProjectsSchemasGetIamPolicyCall) Fields ¶ added in v0.41.0
func (c *ProjectsSchemasGetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsSchemasGetIamPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsSchemasGetIamPolicyCall) Header ¶ added in v0.41.0
func (c *ProjectsSchemasGetIamPolicyCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsSchemasGetIamPolicyCall) IfNoneMatch ¶ added in v0.41.0
func (c *ProjectsSchemasGetIamPolicyCall) IfNoneMatch(entityTag string) *ProjectsSchemasGetIamPolicyCall
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 (*ProjectsSchemasGetIamPolicyCall) OptionsRequestedPolicyVersion ¶ added in v0.41.0
func (c *ProjectsSchemasGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsSchemasGetIamPolicyCall
OptionsRequestedPolicyVersion sets the optional parameter "options.requestedPolicyVersion": The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
type ProjectsSchemasListCall ¶ added in v0.41.0
type ProjectsSchemasListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSchemasListCall) Context ¶ added in v0.41.0
func (c *ProjectsSchemasListCall) Context(ctx context.Context) *ProjectsSchemasListCall
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 (*ProjectsSchemasListCall) Do ¶ added in v0.41.0
func (c *ProjectsSchemasListCall) Do(opts ...googleapi.CallOption) (*ListSchemasResponse, error)
Do executes the "pubsub.projects.schemas.list" call. Exactly one of *ListSchemasResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListSchemasResponse.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 (*ProjectsSchemasListCall) Fields ¶ added in v0.41.0
func (c *ProjectsSchemasListCall) Fields(s ...googleapi.Field) *ProjectsSchemasListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsSchemasListCall) Header ¶ added in v0.41.0
func (c *ProjectsSchemasListCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
func (*ProjectsSchemasListCall) IfNoneMatch ¶ added in v0.41.0
func (c *ProjectsSchemasListCall) IfNoneMatch(entityTag string) *ProjectsSchemasListCall
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 (*ProjectsSchemasListCall) PageSize ¶ added in v0.41.0
func (c *ProjectsSchemasListCall) PageSize(pageSize int64) *ProjectsSchemasListCall
PageSize sets the optional parameter "pageSize": Maximum number of schemas to return.
func (*ProjectsSchemasListCall) PageToken ¶ added in v0.41.0
func (c *ProjectsSchemasListCall) PageToken(pageToken string) *ProjectsSchemasListCall
PageToken sets the optional parameter "pageToken": The value returned by the last `ListSchemasResponse`; indicates that this is a continuation of a prior `ListSchemas` call, and that the system should return the next page of data.
func (*ProjectsSchemasListCall) Pages ¶ added in v0.41.0
func (c *ProjectsSchemasListCall) Pages(ctx context.Context, f func(*ListSchemasResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
func (*ProjectsSchemasListCall) View ¶ added in v0.41.0
func (c *ProjectsSchemasListCall) View(view string) *ProjectsSchemasListCall
View sets the optional parameter "view": The set of Schema fields to return in the response. If not set, returns Schemas with `name` and `type`, but not `definition`. Set to `FULL` to retrieve all fields.
Possible values:
"SCHEMA_VIEW_UNSPECIFIED" - The default / unset value. The API will
default to the BASIC view.
"BASIC" - Include the name and type of the schema, but not the
definition.
"FULL" - Include all Schema object fields.
type ProjectsSchemasService ¶ added in v0.41.0
type ProjectsSchemasService struct {
// contains filtered or unexported fields
}
func NewProjectsSchemasService ¶ added in v0.41.0
func NewProjectsSchemasService(s *Service) *ProjectsSchemasService
func (*ProjectsSchemasService) Create ¶ added in v0.41.0
func (r *ProjectsSchemasService) Create(parent string, schema *Schema) *ProjectsSchemasCreateCall
Create: Creates a schema.
func (*ProjectsSchemasService) Delete ¶ added in v0.41.0
func (r *ProjectsSchemasService) Delete(name string) *ProjectsSchemasDeleteCall
Delete: Deletes a schema.
func (*ProjectsSchemasService) Get ¶ added in v0.41.0
func (r *ProjectsSchemasService) Get(name string) *ProjectsSchemasGetCall
Get: Gets a schema.
func (*ProjectsSchemasService) GetIamPolicy ¶ added in v0.41.0
func (r *ProjectsSchemasService) GetIamPolicy(resource string) *ProjectsSchemasGetIamPolicyCall
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 (*ProjectsSchemasService) List ¶ added in v0.41.0
func (r *ProjectsSchemasService) List(parent string) *ProjectsSchemasListCall
List: Lists schemas in a project.
func (*ProjectsSchemasService) SetIamPolicy ¶ added in v0.41.0
func (r *ProjectsSchemasService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsSchemasSetIamPolicyCall
SetIamPolicy: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
func (*ProjectsSchemasService) TestIamPermissions ¶ added in v0.41.0
func (r *ProjectsSchemasService) TestIamPermissions(resource string, testiampermissionsrequest *TestIamPermissionsRequest) *ProjectsSchemasTestIamPermissionsCall
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.
func (*ProjectsSchemasService) Validate ¶ added in v0.41.0
func (r *ProjectsSchemasService) Validate(parent string, validateschemarequest *ValidateSchemaRequest) *ProjectsSchemasValidateCall
Validate: Validates a schema.
func (*ProjectsSchemasService) ValidateMessage ¶ added in v0.41.0
func (r *ProjectsSchemasService) ValidateMessage(parent string, validatemessagerequest *ValidateMessageRequest) *ProjectsSchemasValidateMessageCall
ValidateMessage: Validates a message against a schema.
type ProjectsSchemasSetIamPolicyCall ¶ added in v0.41.0
type ProjectsSchemasSetIamPolicyCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSchemasSetIamPolicyCall) Context ¶ added in v0.41.0
func (c *ProjectsSchemasSetIamPolicyCall) Context(ctx context.Context) *ProjectsSchemasSetIamPolicyCall
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 (*ProjectsSchemasSetIamPolicyCall) Do ¶ added in v0.41.0
func (c *ProjectsSchemasSetIamPolicyCall) Do(opts ...googleapi.CallOption) (*Policy, error)
Do executes the "pubsub.projects.schemas.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 (*ProjectsSchemasSetIamPolicyCall) Fields ¶ added in v0.41.0
func (c *ProjectsSchemasSetIamPolicyCall) Fields(s ...googleapi.Field) *ProjectsSchemasSetIamPolicyCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsSchemasSetIamPolicyCall) Header ¶ added in v0.41.0
func (c *ProjectsSchemasSetIamPolicyCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsSchemasTestIamPermissionsCall ¶ added in v0.41.0
type ProjectsSchemasTestIamPermissionsCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSchemasTestIamPermissionsCall) Context ¶ added in v0.41.0
func (c *ProjectsSchemasTestIamPermissionsCall) Context(ctx context.Context) *ProjectsSchemasTestIamPermissionsCall
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 (*ProjectsSchemasTestIamPermissionsCall) Do ¶ added in v0.41.0
func (c *ProjectsSchemasTestIamPermissionsCall) Do(opts ...googleapi.CallOption) (*TestIamPermissionsResponse, error)
Do executes the "pubsub.projects.schemas.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 (*ProjectsSchemasTestIamPermissionsCall) Fields ¶ added in v0.41.0
func (c *ProjectsSchemasTestIamPermissionsCall) Fields(s ...googleapi.Field) *ProjectsSchemasTestIamPermissionsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsSchemasTestIamPermissionsCall) Header ¶ added in v0.41.0
func (c *ProjectsSchemasTestIamPermissionsCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsSchemasValidateCall ¶ added in v0.41.0
type ProjectsSchemasValidateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSchemasValidateCall) Context ¶ added in v0.41.0
func (c *ProjectsSchemasValidateCall) Context(ctx context.Context) *ProjectsSchemasValidateCall
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 (*ProjectsSchemasValidateCall) Do ¶ added in v0.41.0
func (c *ProjectsSchemasValidateCall) Do(opts ...googleapi.CallOption) (*ValidateSchemaResponse, error)
Do executes the "pubsub.projects.schemas.validate" call. Exactly one of *ValidateSchemaResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ValidateSchemaResponse.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 (*ProjectsSchemasValidateCall) Fields ¶ added in v0.41.0
func (c *ProjectsSchemasValidateCall) Fields(s ...googleapi.Field) *ProjectsSchemasValidateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsSchemasValidateCall) Header ¶ added in v0.41.0
func (c *ProjectsSchemasValidateCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsSchemasValidateMessageCall ¶ added in v0.41.0
type ProjectsSchemasValidateMessageCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSchemasValidateMessageCall) Context ¶ added in v0.41.0
func (c *ProjectsSchemasValidateMessageCall) Context(ctx context.Context) *ProjectsSchemasValidateMessageCall
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 (*ProjectsSchemasValidateMessageCall) Do ¶ added in v0.41.0
func (c *ProjectsSchemasValidateMessageCall) Do(opts ...googleapi.CallOption) (*ValidateMessageResponse, error)
Do executes the "pubsub.projects.schemas.validateMessage" call. Exactly one of *ValidateMessageResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ValidateMessageResponse.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 (*ProjectsSchemasValidateMessageCall) Fields ¶ added in v0.41.0
func (c *ProjectsSchemasValidateMessageCall) Fields(s ...googleapi.Field) *ProjectsSchemasValidateMessageCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsSchemasValidateMessageCall) Header ¶ added in v0.41.0
func (c *ProjectsSchemasValidateMessageCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsService ¶
type ProjectsService struct { Schemas *ProjectsSchemasService Snapshots *ProjectsSnapshotsService Subscriptions *ProjectsSubscriptionsService Topics *ProjectsTopicsService // contains filtered or unexported fields }
func NewProjectsService ¶
func NewProjectsService(s *Service) *ProjectsService
type ProjectsSnapshotsCreateCall ¶
type ProjectsSnapshotsCreateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSnapshotsCreateCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
type ProjectsSnapshotsDeleteCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSnapshotsDeleteCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
type ProjectsSnapshotsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSnapshotsGetCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
type ProjectsSnapshotsGetIamPolicyCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSnapshotsGetIamPolicyCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶ added in v0.8.0
func (c *ProjectsSnapshotsGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsSnapshotsGetIamPolicyCall
OptionsRequestedPolicyVersion sets the optional parameter "options.requestedPolicyVersion": The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
type ProjectsSnapshotsListCall ¶
type ProjectsSnapshotsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSnapshotsListCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
func (c *ProjectsSnapshotsListCall) PageSize(pageSize int64) *ProjectsSnapshotsListCall
PageSize sets the optional parameter "pageSize": Maximum number of snapshots to return.
func (*ProjectsSnapshotsListCall) PageToken ¶
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 ¶
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 ¶
type ProjectsSnapshotsPatchCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSnapshotsPatchCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
type ProjectsSnapshotsService struct {
// contains filtered or unexported fields
}
func NewProjectsSnapshotsService ¶
func NewProjectsSnapshotsService(s *Service) *ProjectsSnapshotsService
func (*ProjectsSnapshotsService) Create ¶
func (r *ProjectsSnapshotsService) Create(name string, createsnapshotrequest *CreateSnapshotRequest) *ProjectsSnapshotsCreateCall
Create: Creates a snapshot from the requested subscription. Snapshots are used in Seek (https://cloud.google.com/pubsub/docs/replay-overview) operations, 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. 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 ¶
func (r *ProjectsSnapshotsService) Delete(snapshot string) *ProjectsSnapshotsDeleteCall
Delete: Removes an existing snapshot. Snapshots are used in [Seek] (https://cloud.google.com/pubsub/docs/replay-overview) operations, 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. 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 ¶
func (r *ProjectsSnapshotsService) Get(snapshot string) *ProjectsSnapshotsGetCall
Get: Gets the configuration details of a snapshot. Snapshots are used in Seek operations, 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 ¶
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 ¶
func (r *ProjectsSnapshotsService) List(project string) *ProjectsSnapshotsListCall
List: Lists the existing snapshots. Snapshots are used in Seek ( https://cloud.google.com/pubsub/docs/replay-overview) operations, 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 ¶
func (r *ProjectsSnapshotsService) Patch(name string, updatesnapshotrequest *UpdateSnapshotRequest) *ProjectsSnapshotsPatchCall
Patch: Updates an existing snapshot. Snapshots are used in Seek operations, 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 ¶
func (r *ProjectsSnapshotsService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsSnapshotsSetIamPolicyCall
SetIamPolicy: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
func (*ProjectsSnapshotsService) TestIamPermissions ¶
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 ¶
type ProjectsSnapshotsSetIamPolicyCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSnapshotsSetIamPolicyCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
type ProjectsSnapshotsTestIamPermissionsCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSnapshotsTestIamPermissionsCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
type ProjectsSubscriptionsAcknowledgeCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSubscriptionsAcknowledgeCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
type ProjectsSubscriptionsCreateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSubscriptionsCreateCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
type ProjectsSubscriptionsDeleteCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSubscriptionsDeleteCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ProjectsSubscriptionsDetachCall ¶ added in v0.27.0
type ProjectsSubscriptionsDetachCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSubscriptionsDetachCall) Context ¶ added in v0.27.0
func (c *ProjectsSubscriptionsDetachCall) Context(ctx context.Context) *ProjectsSubscriptionsDetachCall
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 (*ProjectsSubscriptionsDetachCall) Do ¶ added in v0.27.0
func (c *ProjectsSubscriptionsDetachCall) Do(opts ...googleapi.CallOption) (*DetachSubscriptionResponse, error)
Do executes the "pubsub.projects.subscriptions.detach" call. Exactly one of *DetachSubscriptionResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *DetachSubscriptionResponse.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 (*ProjectsSubscriptionsDetachCall) Fields ¶ added in v0.27.0
func (c *ProjectsSubscriptionsDetachCall) Fields(s ...googleapi.Field) *ProjectsSubscriptionsDetachCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*ProjectsSubscriptionsDetachCall) Header ¶ added in v0.27.0
func (c *ProjectsSubscriptionsDetachCall) Header() http.Header
Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.
type ProjectsSubscriptionsGetCall ¶
type ProjectsSubscriptionsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSubscriptionsGetCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
type ProjectsSubscriptionsGetIamPolicyCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSubscriptionsGetIamPolicyCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶ added in v0.8.0
func (c *ProjectsSubscriptionsGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsSubscriptionsGetIamPolicyCall
OptionsRequestedPolicyVersion sets the optional parameter "options.requestedPolicyVersion": The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
type ProjectsSubscriptionsListCall ¶
type ProjectsSubscriptionsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSubscriptionsListCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
func (c *ProjectsSubscriptionsListCall) PageSize(pageSize int64) *ProjectsSubscriptionsListCall
PageSize sets the optional parameter "pageSize": Maximum number of subscriptions to return.
func (*ProjectsSubscriptionsListCall) PageToken ¶
func (c *ProjectsSubscriptionsListCall) PageToken(pageToken string) *ProjectsSubscriptionsListCall
PageToken sets the optional parameter "pageToken": The value returned by the last `ListSubscriptionsResponse`; indicates that this is a continuation of a prior `ListSubscriptions` call, and that the system should return the next page of data.
func (*ProjectsSubscriptionsListCall) Pages ¶
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 ¶
type ProjectsSubscriptionsModifyAckDeadlineCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSubscriptionsModifyAckDeadlineCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
type ProjectsSubscriptionsModifyPushConfigCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSubscriptionsModifyPushConfigCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
type ProjectsSubscriptionsPatchCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSubscriptionsPatchCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
type ProjectsSubscriptionsPullCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSubscriptionsPullCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
type ProjectsSubscriptionsSeekCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSubscriptionsSeekCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
type ProjectsSubscriptionsService struct {
// contains filtered or unexported fields
}
func NewProjectsSubscriptionsService ¶
func NewProjectsSubscriptionsService(s *Service) *ProjectsSubscriptionsService
func (*ProjectsSubscriptionsService) Acknowledge ¶
func (r *ProjectsSubscriptionsService) Acknowledge(subscription string, acknowledgerequest *AcknowledgeRequest) *ProjectsSubscriptionsAcknowledgeCall
Acknowledge: Acknowledges the messages associated with the `ack_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 ¶
func (r *ProjectsSubscriptionsService) Create(name string, subscription *Subscription) *ProjectsSubscriptionsCreateCall
Create: Creates a subscription to a given topic. See the [resource name rules] (https://cloud.google.com/pubsub/docs/admin#resource_names). 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 ¶
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) Detach ¶ added in v0.27.0
func (r *ProjectsSubscriptionsService) Detach(subscription string) *ProjectsSubscriptionsDetachCall
Detach: Detaches a subscription from this topic. All messages retained in the subscription are dropped. Subsequent `Pull` and `StreamingPull` requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will stop.
func (*ProjectsSubscriptionsService) Get ¶
func (r *ProjectsSubscriptionsService) Get(subscription string) *ProjectsSubscriptionsGetCall
Get: Gets the configuration details of a subscription.
func (*ProjectsSubscriptionsService) GetIamPolicy ¶
func (r *ProjectsSubscriptionsService) GetIamPolicy(resource string) *ProjectsSubscriptionsGetIamPolicyCall
GetIamPolicy: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
func (*ProjectsSubscriptionsService) List ¶
func (r *ProjectsSubscriptionsService) List(project string) *ProjectsSubscriptionsListCall
List: Lists matching subscriptions.
func (*ProjectsSubscriptionsService) ModifyAckDeadline ¶
func (r *ProjectsSubscriptionsService) ModifyAckDeadline(subscription string, modifyackdeadlinerequest *ModifyAckDeadlineRequest) *ProjectsSubscriptionsModifyAckDeadlineCall
ModifyAckDeadline: Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. Note that this does not modify the subscription-level `ackDeadlineSeconds` used for subsequent messages.
func (*ProjectsSubscriptionsService) ModifyPushConfig ¶
func (r *ProjectsSubscriptionsService) ModifyPushConfig(subscription string, modifypushconfigrequest *ModifyPushConfigRequest) *ProjectsSubscriptionsModifyPushConfigCall
ModifyPushConfig: Modifies the `PushConfig` for a specified subscription. This may be used to change a push subscription to a pull one (signified by an empty `PushConfig`) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the `PushConfig`.
func (*ProjectsSubscriptionsService) Patch ¶
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 ¶
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 ¶
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 [Seek] (https://cloud.google.com/pubsub/docs/replay-overview) operations, 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 ¶
func (r *ProjectsSubscriptionsService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsSubscriptionsSetIamPolicyCall
SetIamPolicy: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
func (*ProjectsSubscriptionsService) TestIamPermissions ¶
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 ¶
type ProjectsSubscriptionsSetIamPolicyCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSubscriptionsSetIamPolicyCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
type ProjectsSubscriptionsTestIamPermissionsCall struct {
// contains filtered or unexported fields
}
func (*ProjectsSubscriptionsTestIamPermissionsCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
type ProjectsTopicsCreateCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTopicsCreateCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
type ProjectsTopicsDeleteCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTopicsDeleteCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
type ProjectsTopicsGetCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTopicsGetCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
type ProjectsTopicsGetIamPolicyCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTopicsGetIamPolicyCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶ added in v0.8.0
func (c *ProjectsTopicsGetIamPolicyCall) OptionsRequestedPolicyVersion(optionsRequestedPolicyVersion int64) *ProjectsTopicsGetIamPolicyCall
OptionsRequestedPolicyVersion sets the optional parameter "options.requestedPolicyVersion": The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
type ProjectsTopicsListCall ¶
type ProjectsTopicsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTopicsListCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
func (c *ProjectsTopicsListCall) PageSize(pageSize int64) *ProjectsTopicsListCall
PageSize sets the optional parameter "pageSize": Maximum number of topics to return.
func (*ProjectsTopicsListCall) PageToken ¶
func (c *ProjectsTopicsListCall) PageToken(pageToken string) *ProjectsTopicsListCall
PageToken sets the optional parameter "pageToken": The value returned by the last `ListTopicsResponse`; indicates that this is a continuation of a prior `ListTopics` call, and that the system should return the next page of data.
func (*ProjectsTopicsListCall) Pages ¶
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 ¶
type ProjectsTopicsPatchCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTopicsPatchCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
type ProjectsTopicsPublishCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTopicsPublishCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
type ProjectsTopicsService struct { Snapshots *ProjectsTopicsSnapshotsService Subscriptions *ProjectsTopicsSubscriptionsService // contains filtered or unexported fields }
func NewProjectsTopicsService ¶
func NewProjectsTopicsService(s *Service) *ProjectsTopicsService
func (*ProjectsTopicsService) Create ¶
func (r *ProjectsTopicsService) Create(name string, topic *Topic) *ProjectsTopicsCreateCall
Create: Creates the given topic with the given name. See the [resource name rules] (https://cloud.google.com/pubsub/docs/admin#resource_names).
func (*ProjectsTopicsService) Delete ¶
func (r *ProjectsTopicsService) Delete(topic string) *ProjectsTopicsDeleteCall
Delete: Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `_deleted-topic_`.
func (*ProjectsTopicsService) Get ¶
func (r *ProjectsTopicsService) Get(topic string) *ProjectsTopicsGetCall
Get: Gets the configuration of a topic.
func (*ProjectsTopicsService) GetIamPolicy ¶
func (r *ProjectsTopicsService) GetIamPolicy(resource string) *ProjectsTopicsGetIamPolicyCall
GetIamPolicy: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
func (*ProjectsTopicsService) List ¶
func (r *ProjectsTopicsService) List(project string) *ProjectsTopicsListCall
List: Lists matching topics.
func (*ProjectsTopicsService) Patch ¶
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 ¶
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 ¶
func (r *ProjectsTopicsService) SetIamPolicy(resource string, setiampolicyrequest *SetIamPolicyRequest) *ProjectsTopicsSetIamPolicyCall
SetIamPolicy: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
func (*ProjectsTopicsService) TestIamPermissions ¶
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 ¶
type ProjectsTopicsSetIamPolicyCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTopicsSetIamPolicyCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
type ProjectsTopicsSnapshotsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTopicsSnapshotsListCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
func (c *ProjectsTopicsSnapshotsListCall) PageSize(pageSize int64) *ProjectsTopicsSnapshotsListCall
PageSize sets the optional parameter "pageSize": Maximum number of snapshot names to return.
func (*ProjectsTopicsSnapshotsListCall) PageToken ¶
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 ¶
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 ¶
type ProjectsTopicsSnapshotsService struct {
// contains filtered or unexported fields
}
func NewProjectsTopicsSnapshotsService ¶
func NewProjectsTopicsSnapshotsService(s *Service) *ProjectsTopicsSnapshotsService
func (*ProjectsTopicsSnapshotsService) List ¶
func (r *ProjectsTopicsSnapshotsService) List(topic string) *ProjectsTopicsSnapshotsListCall
List: Lists the names of the snapshots on this topic. Snapshots are used in Seek (https://cloud.google.com/pubsub/docs/replay-overview) operations, 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 ¶
type ProjectsTopicsSubscriptionsListCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTopicsSubscriptionsListCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
func (c *ProjectsTopicsSubscriptionsListCall) PageSize(pageSize int64) *ProjectsTopicsSubscriptionsListCall
PageSize sets the optional parameter "pageSize": Maximum number of subscription names to return.
func (*ProjectsTopicsSubscriptionsListCall) PageToken ¶
func (c *ProjectsTopicsSubscriptionsListCall) PageToken(pageToken string) *ProjectsTopicsSubscriptionsListCall
PageToken sets the optional parameter "pageToken": The value returned by the last `ListTopicSubscriptionsResponse`; indicates that this is a continuation of a prior `ListTopicSubscriptions` call, and that the system should return the next page of data.
func (*ProjectsTopicsSubscriptionsListCall) Pages ¶
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 ¶
type ProjectsTopicsSubscriptionsService struct {
// contains filtered or unexported fields
}
func NewProjectsTopicsSubscriptionsService ¶
func NewProjectsTopicsSubscriptionsService(s *Service) *ProjectsTopicsSubscriptionsService
func (*ProjectsTopicsSubscriptionsService) List ¶
func (r *ProjectsTopicsSubscriptionsService) List(topic string) *ProjectsTopicsSubscriptionsListCall
List: Lists the names of the attached subscriptions on this topic.
type ProjectsTopicsTestIamPermissionsCall ¶
type ProjectsTopicsTestIamPermissionsCall struct {
// contains filtered or unexported fields
}
func (*ProjectsTopicsTestIamPermissionsCall) Context ¶
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 ¶
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 ¶
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 ¶
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 ¶
type PublishRequest struct { // Messages: Required. 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 ¶
func (s *PublishRequest) MarshalJSON() ([]byte, error)
type PublishResponse ¶
type PublishResponse struct { // MessageIds: The server-assigned ID of each published message, in the // same order as the messages in the request. IDs are guaranteed to be // unique within the topic. MessageIds []string `json:"messageIds,omitempty"` // 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 ¶
func (s *PublishResponse) MarshalJSON() ([]byte, error)
type PubsubMessage ¶
type PubsubMessage struct { // Attributes: Attributes for this message. If this field is empty, the // message must contain non-empty data. This can be used to filter // messages on the subscription. 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"` // OrderingKey: If non-empty, identifies related messages for which // publish order should be respected. If a `Subscription` has // `enable_message_ordering` set to `true`, messages published with the // same non-empty `ordering_key` value will be delivered to subscribers // in the order in which they are received by the Pub/Sub system. All // `PubsubMessage`s published in a given `PublishRequest` must specify // the same `ordering_key` value. OrderingKey string `json:"orderingKey,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 client library documentation (https://cloud.google.com/pubsub/docs/reference/libraries) for more information. See [quotas and limits] (https://cloud.google.com/pubsub/quotas) for more information about message limits.
func (*PubsubMessage) MarshalJSON ¶
func (s *PubsubMessage) MarshalJSON() ([]byte, error)
type PullRequest ¶
type PullRequest struct { // MaxMessages: Required. The maximum number of messages to return for // this request. Must be a positive integer. The Pub/Sub system may // return fewer than the number specified. MaxMessages int64 `json:"maxMessages,omitempty"` // ReturnImmediately: Optional. 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. Warning: setting this field to // `true` is discouraged because it adversely impacts the performance of // `Pull` operations. We recommend that users do not set this field. 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 ¶
func (s *PullRequest) MarshalJSON() ([]byte, error)
type PullResponse ¶
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 ¶
func (s *PullResponse) MarshalJSON() ([]byte, error)
type PushConfig ¶
type PushConfig struct { // Attributes: Endpoint configuration attributes that can be used to // control different aspects of the message delivery. The only 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). If not present // during the `CreateSubscription` call, it will default to the version // of the Pub/Sub API used to make such call. If not present in 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 only // supported values for the `x-goog-version` 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. For // example: attributes { "x-goog-version": "v1" } 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 ¶
func (s *PushConfig) MarshalJSON() ([]byte, error)
type ReceivedMessage ¶
type ReceivedMessage struct { // AckId: This ID can be used to acknowledge the received message. AckId string `json:"ackId,omitempty"` // DeliveryAttempt: The approximate number of times that Cloud Pub/Sub // has attempted to deliver the associated message to a subscriber. More // precisely, this is 1 + (number of NACKs) + (number of ack_deadline // exceeds) for this message. A NACK is any call to ModifyAckDeadline // with a 0 deadline. An ack_deadline exceeds event is whenever a // message is not acknowledged within ack_deadline. Note that // ack_deadline is initially Subscription.ackDeadlineSeconds, but may // get extended automatically by the client library. Upon the first // delivery of a given message, `delivery_attempt` will have a value of // 1. The value is calculated at best effort and is approximate. If a // DeadLetterPolicy is not set on the subscription, this will be 0. DeliveryAttempt int64 `json:"deliveryAttempt,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 ¶
func (s *ReceivedMessage) MarshalJSON() ([]byte, error)
type RetryPolicy ¶ added in v0.27.0
type RetryPolicy struct { // MaximumBackoff: The maximum delay between consecutive deliveries of a // given message. Value should be between 0 and 600 seconds. Defaults to // 600 seconds. MaximumBackoff string `json:"maximumBackoff,omitempty"` // MinimumBackoff: The minimum delay between consecutive deliveries of a // given message. Value should be between 0 and 600 seconds. Defaults to // 10 seconds. MinimumBackoff string `json:"minimumBackoff,omitempty"` // ForceSendFields is a list of field names (e.g. "MaximumBackoff") 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. "MaximumBackoff") 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:"-"` }
RetryPolicy: A policy that specifies how Cloud Pub/Sub retries message delivery. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message. Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff.
func (*RetryPolicy) MarshalJSON ¶ added in v0.27.0
func (s *RetryPolicy) MarshalJSON() ([]byte, error)
type Schema ¶ added in v0.41.0
type Schema struct { // Definition: The definition of the schema. This should contain a // string representing the full definition of the schema that is a valid // schema definition of the type specified in `type`. Definition string `json:"definition,omitempty"` // Name: Required. Name of the schema. Format is // `projects/{project}/schemas/{schema}`. Name string `json:"name,omitempty"` // Type: The type of the schema definition. // // Possible values: // "TYPE_UNSPECIFIED" - Default value. This value is unused. // "PROTOCOL_BUFFER" - A Protocol Buffer schema definition. // "AVRO" - An Avro schema definition. Type string `json:"type,omitempty"` // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` // ForceSendFields is a list of field names (e.g. "Definition") 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. "Definition") 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:"-"` }
Schema: A schema resource.
func (*Schema) MarshalJSON ¶ added in v0.41.0
type SchemaSettings ¶ added in v0.41.0
type SchemaSettings struct { // Encoding: The encoding of messages validated against `schema`. // // Possible values: // "ENCODING_UNSPECIFIED" - Unspecified // "JSON" - JSON encoding // "BINARY" - Binary encoding, as defined by the schema type. For some // schema types, binary encoding may not be available. Encoding string `json:"encoding,omitempty"` // Schema: Required. The name of the schema that messages published // should be validated against. Format is // `projects/{project}/schemas/{schema}`. The value of this field will // be `_deleted-schema_` if the schema has been deleted. Schema string `json:"schema,omitempty"` // ForceSendFields is a list of field names (e.g. "Encoding") 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. "Encoding") 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:"-"` }
SchemaSettings: Settings for validating messages published against a schema.
func (*SchemaSettings) MarshalJSON ¶ added in v0.41.0
func (s *SchemaSettings) MarshalJSON() ([]byte, error)
type SeekRequest ¶
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 ¶
func (s *SeekRequest) MarshalJSON() ([]byte, error)
type SeekResponse ¶
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 ¶
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
deprecated
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func NewService ¶ added in v0.3.0
NewService creates a new Service.
type SetIamPolicyRequest ¶
type SetIamPolicyRequest struct { // Policy: REQUIRED: The complete policy to be applied to the // `resource`. The size of the policy is limited to a few 10s of KB. An // empty policy is 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 ¶
func (s *SetIamPolicyRequest) MarshalJSON() ([]byte, error)
type Snapshot ¶
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 [Creating and managing labels] // (https://cloud.google.com/pubsub/docs/labels). 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 Seek (https://cloud.google.com/pubsub/docs/replay-overview) operations, 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 ¶
type Subscription ¶
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 *outstanding*. // 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"` // DeadLetterPolicy: A policy that specifies the conditions for dead // lettering messages in this subscription. If dead_letter_policy is not // set, dead lettering is disabled. The Cloud Pub/Sub service account // associated with this subscriptions's parent project (i.e., // service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must // have permission to Acknowledge() messages on this subscription. DeadLetterPolicy *DeadLetterPolicy `json:"deadLetterPolicy,omitempty"` // Detached: Indicates whether the subscription is detached from its // topic. Detached subscriptions don't receive messages from their topic // and don't retain any backlog. `Pull` and `StreamingPull` requests // will return FAILED_PRECONDITION. If the subscription is a push // subscription, pushes to the endpoint will not be made. Detached bool `json:"detached,omitempty"` // EnableMessageOrdering: If true, messages published with the same // `ordering_key` in `PubsubMessage` will be delivered to the // subscribers in the order in which they are received by the Pub/Sub // system. Otherwise, they may be delivered in any order. EnableMessageOrdering bool `json:"enableMessageOrdering,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"` // Filter: An expression written in the Pub/Sub filter language // (https://cloud.google.com/pubsub/docs/filtering). If non-empty, then // only `PubsubMessage`s whose `attributes` field matches the filter are // delivered on this subscription. If empty, then no messages are // filtered out. Filter string `json:"filter,omitempty"` // Labels: See Creating and managing labels. 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: Required. 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 [Seek to a timestamp] // (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time). RetainAckedMessages bool `json:"retainAckedMessages,omitempty"` // RetryPolicy: A policy that specifies how Pub/Sub retries message // delivery for this subscription. If not set, the default retry policy // is applied. This generally implies that messages will be retried as // soon as possible for healthy subscribers. RetryPolicy will be // triggered on NACKs or acknowledgement deadline exceeded events for a // given message. RetryPolicy *RetryPolicy `json:"retryPolicy,omitempty"` // Topic: Required. 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 ¶
func (s *Subscription) MarshalJSON() ([]byte, error)
type TestIamPermissionsRequest ¶
type TestIamPermissionsRequest struct { // Permissions: The set of permissions to check for the `resource`. // Permissions with wildcards (such as '*' or 'storage.*') are not // allowed. 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 ¶
func (s *TestIamPermissionsRequest) MarshalJSON() ([]byte, error)
type TestIamPermissionsResponse ¶
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 ¶
func (s *TestIamPermissionsResponse) MarshalJSON() ([]byte, error)
type Topic ¶
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 [Creating and managing labels] // (https://cloud.google.com/pubsub/docs/labels). 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: Required. 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"` // SatisfiesPzs: Reserved for future use. This field is set only in // responses from the server; it is ignored if it is set in any // requests. SatisfiesPzs bool `json:"satisfiesPzs,omitempty"` // SchemaSettings: Settings for validating messages published against a // schema. SchemaSettings *SchemaSettings `json:"schemaSettings,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 ¶
type UpdateSnapshotRequest ¶
type UpdateSnapshotRequest struct { // Snapshot: Required. The updated snapshot object. Snapshot *Snapshot `json:"snapshot,omitempty"` // UpdateMask: Required. 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 ¶
func (s *UpdateSnapshotRequest) MarshalJSON() ([]byte, error)
type UpdateSubscriptionRequest ¶
type UpdateSubscriptionRequest struct { // Subscription: Required. The updated subscription object. Subscription *Subscription `json:"subscription,omitempty"` // UpdateMask: Required. 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 ¶
func (s *UpdateSubscriptionRequest) MarshalJSON() ([]byte, error)
type UpdateTopicRequest ¶
type UpdateTopicRequest struct { // Topic: Required. The updated topic object. Topic *Topic `json:"topic,omitempty"` // UpdateMask: Required. Indicates which fields in the provided topic to // update. Must be specified and non-empty. Note that if `update_mask` // contains "message_storage_policy" but the `message_storage_policy` is // not set in the `topic` provided above, then the updated value is // determined by the policy configured at the project or organization // level. 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 ¶
func (s *UpdateTopicRequest) MarshalJSON() ([]byte, error)
type ValidateMessageRequest ¶ added in v0.41.0
type ValidateMessageRequest struct { // Encoding: The encoding expected for messages // // Possible values: // "ENCODING_UNSPECIFIED" - Unspecified // "JSON" - JSON encoding // "BINARY" - Binary encoding, as defined by the schema type. For some // schema types, binary encoding may not be available. Encoding string `json:"encoding,omitempty"` // Message: Message to validate against the provided `schema_spec`. Message string `json:"message,omitempty"` // Name: Name of the schema against which to validate. Format is // `projects/{project}/schemas/{schema}`. Name string `json:"name,omitempty"` // Schema: Ad-hoc schema against which to validate Schema *Schema `json:"schema,omitempty"` // ForceSendFields is a list of field names (e.g. "Encoding") 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. "Encoding") 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:"-"` }
ValidateMessageRequest: Request for the `ValidateMessage` method.
func (*ValidateMessageRequest) MarshalJSON ¶ added in v0.41.0
func (s *ValidateMessageRequest) MarshalJSON() ([]byte, error)
type ValidateMessageResponse ¶ added in v0.41.0
type ValidateMessageResponse struct { // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` }
ValidateMessageResponse: Response for the `ValidateMessage` method. Empty for now.
type ValidateSchemaRequest ¶ added in v0.41.0
type ValidateSchemaRequest struct { // Schema: Required. The schema object to validate. Schema *Schema `json:"schema,omitempty"` // ForceSendFields is a list of field names (e.g. "Schema") 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. "Schema") 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:"-"` }
ValidateSchemaRequest: Request for the `ValidateSchema` method.
func (*ValidateSchemaRequest) MarshalJSON ¶ added in v0.41.0
func (s *ValidateSchemaRequest) MarshalJSON() ([]byte, error)
type ValidateSchemaResponse ¶ added in v0.41.0
type ValidateSchemaResponse struct { // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` }
ValidateSchemaResponse: Response for the `ValidateSchema` method. Empty for now.