Namespace Google.Apis.Pubsub.v1
Classes
ProjectsResource
The "projects" collection of methods.
ProjectsResource.SchemasResource
The "schemas" collection of methods.
ProjectsResource.SchemasResource.CommitRequest
Commits a new schema revision to an existing schema.
ProjectsResource.SchemasResource.CreateRequest
Creates a schema.
ProjectsResource.SchemasResource.DeleteRequest
Deletes a schema.
ProjectsResource.SchemasResource.DeleteRevisionRequest
Deletes a specific schema revision.
ProjectsResource.SchemasResource.GetIamPolicyRequest
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
ProjectsResource.SchemasResource.GetRequest
Gets a schema.
ProjectsResource.SchemasResource.ListRequest
Lists schemas in a project.
ProjectsResource.SchemasResource.ListRevisionsRequest
Lists all schema revisions for the named schema.
ProjectsResource.SchemasResource.RollbackRequest
Creates a new schema revision that is a copy of the provided revision_id.
ProjectsResource.SchemasResource.SetIamPolicyRequest
Sets the access control policy on the specified resource. Replaces any existing policy. Can return
NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
ProjectsResource.SchemasResource.TestIamPermissionsRequest
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.
ProjectsResource.SchemasResource.ValidateMessageRequest
Validates a message against a schema.
ProjectsResource.SchemasResource.ValidateRequest
Validates a schema.
ProjectsResource.SnapshotsResource
The "snapshots" collection of methods.
ProjectsResource.SnapshotsResource.CreateRequest
Creates a snapshot from the requested subscription. 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. 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/pubsub-basics#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.
ProjectsResource.SnapshotsResource.DeleteRequest
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.
ProjectsResource.SnapshotsResource.GetIamPolicyRequest
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
ProjectsResource.SnapshotsResource.GetRequest
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.
ProjectsResource.SnapshotsResource.ListRequest
Lists the existing snapshots. 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.
ProjectsResource.SnapshotsResource.PatchRequest
Updates an existing snapshot by updating the fields specified in the update mask. 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.
ProjectsResource.SnapshotsResource.SetIamPolicyRequest
Sets the access control policy on the specified resource. Replaces any existing policy. Can return
NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
ProjectsResource.SnapshotsResource.TestIamPermissionsRequest
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.
ProjectsResource.SubscriptionsResource
The "subscriptions" collection of methods.
ProjectsResource.SubscriptionsResource.AcknowledgeRequest
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.
ProjectsResource.SubscriptionsResource.CreateRequest
Creates a subscription to a given topic. See the [resource name rules]
(https://cloud.google.com/pubsub/docs/pubsub-basics#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/pubsub-basics#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.
ProjectsResource.SubscriptionsResource.DeleteRequest
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.
ProjectsResource.SubscriptionsResource.DetachRequest
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.
ProjectsResource.SubscriptionsResource.GetIamPolicyRequest
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
ProjectsResource.SubscriptionsResource.GetRequest
Gets the configuration details of a subscription.
ProjectsResource.SubscriptionsResource.ListRequest
Lists matching subscriptions.
ProjectsResource.SubscriptionsResource.ModifyAckDeadlineRequest
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.
ProjectsResource.SubscriptionsResource.ModifyPushConfigRequest
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
.
ProjectsResource.SubscriptionsResource.PatchRequest
Updates an existing subscription by updating the fields specified in the update mask. Note that certain properties of a subscription, such as its topic, are not modifiable.
ProjectsResource.SubscriptionsResource.PullRequest
Pulls messages from the server.
ProjectsResource.SubscriptionsResource.SeekRequest
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.
ProjectsResource.SubscriptionsResource.SetIamPolicyRequest
Sets the access control policy on the specified resource. Replaces any existing policy. Can return
NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
ProjectsResource.SubscriptionsResource.TestIamPermissionsRequest
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.
ProjectsResource.TopicsResource
The "topics" collection of methods.
ProjectsResource.TopicsResource.CreateRequest
Creates the given topic with the given name. See the [resource name rules] (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
ProjectsResource.TopicsResource.DeleteRequest
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_
.
ProjectsResource.TopicsResource.GetIamPolicyRequest
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
ProjectsResource.TopicsResource.GetRequest
Gets the configuration of a topic.
ProjectsResource.TopicsResource.ListRequest
Lists matching topics.
ProjectsResource.TopicsResource.PatchRequest
Updates an existing topic by updating the fields specified in the update mask. Note that certain properties of a topic are not modifiable.
ProjectsResource.TopicsResource.PublishRequest
Adds one or more messages to the topic. Returns NOT_FOUND
if the topic does not exist.
ProjectsResource.TopicsResource.SetIamPolicyRequest
Sets the access control policy on the specified resource. Replaces any existing policy. Can return
NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
ProjectsResource.TopicsResource.SnapshotsResource
The "snapshots" collection of methods.
ProjectsResource.TopicsResource.SnapshotsResource.ListRequest
Lists the names of the snapshots on this topic. 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.
ProjectsResource.TopicsResource.SubscriptionsResource
The "subscriptions" collection of methods.
ProjectsResource.TopicsResource.SubscriptionsResource.ListRequest
Lists the names of the attached subscriptions on this topic.
ProjectsResource.TopicsResource.TestIamPermissionsRequest
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.
PubsubBaseServiceRequest<TResponse>
A base abstract class for Pubsub requests.
PubsubService
The Pubsub Service.
PubsubService.Scope
Available OAuth 2.0 scopes for use with the Cloud Pub/Sub API.
PubsubService.ScopeConstants
Available OAuth 2.0 scope constants for use with the Cloud Pub/Sub API.
Enums
ProjectsResource.SchemasResource.GetRequest.ViewEnum
The set of fields to return in the response. If not set, returns a Schema with all fields filled
out. Set to BASIC
to omit the definition
.
ProjectsResource.SchemasResource.ListRequest.ViewEnum
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.
ProjectsResource.SchemasResource.ListRevisionsRequest.ViewEnum
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.
PubsubBaseServiceRequest<TResponse>.AltEnum
Data format for response.
PubsubBaseServiceRequest<TResponse>.XgafvEnum
V1 error format.