Ballerina library

googleapis.cloudpubsub

Module googleapis.cloudpubsub

OverviewPrerequisitesQuickstart

API

Client

Definitions

AcknowledgeRequest
Binding
ClientHttp1Settings
ConnectionConfig
CreateSnapshotRequest
DeadLetterPolicy
ExpirationPolicy
Expr
ListSchemasResponse
ListSnapshotsResponse
ListSubscriptionsResponse
ListTopicSnapshotsResponse
ListTopicsResponse
ListTopicSubscriptionsResponse
MessageStoragePolicy
ModifyAckDeadlineRequest
ModifyPushConfigRequest
OAuth2RefreshTokenGrantConfig
OidcToken
Policy
ProxyConfig
PublishRequest
PublishResponse
PubsubMessage
PullRequest
PullResponse
PushConfig
ReceivedMessage
RetryPolicy
Schema
SchemaSettings
SeekRequest
SetIamPolicyRequest
Snapshot
Subscription
TestIamPermissionsRequest
TestIamPermissionsResponse
Topic
UpdateSnapshotRequest
UpdateSubscriptionRequest
UpdateTopicRequest
ValidateMessageRequest
ValidateSchemaRequest

ballerinax/googleapis.cloudpubsub Ballerina library

1.5.1

Overview

This is a generated connector for Google Cloud Pub/Sub REST API v1 OpenAPI specification. The Google Cloud Pub/Sub API provides the capability to do the messaging and ingestion for event-driven systems and streaming analytics.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

  1. Create a Google account
  2. Obtain tokens - Follow this guide

Quickstart

To use the Google Cloud Pub/Sub connector in your Ballerina application, update the .bal file as follows:

Step 1: Import connector

First, import the ballerinax/googleapis.cloudpubsub module into the Ballerina project.

Copy
import ballerinax/googleapis.cloudpubsub;

Step 2: Create a new connector instance

Create a pubsub:ClientConfig with the OAuth2 tokens obtained, and initialize the connector with it.

Copy
cloudpubsub:ClientConfig clientConfig = {
    auth: {
        clientId: <CLIENT_ID>,
        clientSecret: <CLIENT_SECRET>,
        refreshUrl: <REFRESH_URL>,
        refreshToken: <REFRESH_TOKEN>
    }
};
cloudpubsub:Client baseClient = check new Client(clientConfig);

Step 3: Invoke connector operation

  1. Now you can use the operations available within the connector. Note that they are in the form of remote operations.
    Following is an example on how to list the topics in a project using the connector.

    Copy
    public function main() returns error? {
    cloudpubsub:ListTopicsResponse response = check baseClient->pubsubProjectsTopicsList("xxx");
}

  2. Use bal run command to compile and run the Ballerina program.

Clients

googleapis.cloudpubsub: Client

Isolated

This is a generated connector for Google Cloud Pub/Sub API v1 OpenAPI specification. The Google Cloud Pub/Sub API provides the capability to do the messaging and ingestion for event-driven systems and streaming analytics.

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Create a Google account and obtain tokens by following this guide.

init (ConnectionConfig config, string serviceUrl)
  • config ConnectionConfig - The configurations to be used when initializing the connector
  • serviceUrl string "https://pubsub.googleapis.com/" - URL of the target service

getSchema

Isolated FunctionRemote Function
function getSchema(string name, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? view) returns Schema|error

Gets a schema.

Parameters
  • name string - Required. The name of the schema to get. Format is projects/{project}/schemas/{schema}.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • view string? (default ()) - 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.
Return Type

createTopic

Isolated FunctionRemote Function
function createTopic(string name, Topic payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Topic|error

Creates the given topic with the given name. See the [resource name rules] (https://cloud.google.com/pubsub/docs/admin#resource_names).

Parameters
  • name string - 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".
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

deleteSchema

Isolated FunctionRemote Function
function deleteSchema(string name, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

Deletes a schema.

Parameters
  • name string - Required. Name of the schema to delete. Format is projects/{project}/schemas/{schema}.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

updateTopic

Isolated FunctionRemote Function
function updateTopic(string name, UpdateTopicRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Topic|error

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

Parameters
  • name string - 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".
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

listSchemas

Isolated FunctionRemote Function
function listSchemas(string parent, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, int? pageSize, string? pageToken, string? view) returns ListSchemasResponse|error

Lists schemas in a project.

Parameters
  • parent string - Required. The name of the project in which to list schemas. Format is projects/{project-id}.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • pageSize int? (default ()) - Maximum number of schemas to return.
  • pageToken string? (default ()) - 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.
  • view string? (default ()) - 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.
Return Type

createSchema

Isolated FunctionRemote Function
function createSchema(string parent, Schema payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? schemaId) returns Schema|error

Creates a schema.

Parameters
  • parent string - Required. The name of the project in which to create the schema. Format is projects/{project-id}.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • schemaId string? (default ()) - 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.
Return Type

validateSchema

Isolated FunctionRemote Function
function validateSchema(string parent, ValidateSchemaRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

Validates a schema.

Parameters
  • parent string - Required. The name of the project in which to validate schemas. Format is projects/{project-id}.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

validateSchemaMessage

Isolated FunctionRemote Function
function validateSchemaMessage(string parent, ValidateMessageRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

Validates a message against a schema.

Parameters
  • parent string - Required. The name of the project in which to validate schemas. Format is projects/{project-id}.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

listSnapshot

Isolated FunctionRemote Function
function listSnapshot(string project, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, int? pageSize, string? pageToken) returns ListSnapshotsResponse|error

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.

Parameters
  • project string - Required. The name of the project in which to list snapshots. Format is projects/{project-id}.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • pageSize int? (default ()) - Maximum number of snapshots to return.
  • pageToken string? (default ()) - 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.
Return Type

listSubscriptions

Isolated FunctionRemote Function
function listSubscriptions(string project, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, int? pageSize, string? pageToken) returns ListSubscriptionsResponse|error

Lists matching subscriptions.

Parameters
  • project string - Required. The name of the project in which to list subscriptions. Format is projects/{project-id}.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • pageSize int? (default ()) - Maximum number of subscriptions to return.
  • pageToken string? (default ()) - 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.
Return Type

listTopics

Isolated FunctionRemote Function
function listTopics(string project, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, int? pageSize, string? pageToken) returns ListTopicsResponse|error

Lists matching topics.

Parameters
  • project string - Required. The name of the project in which to list topics. Format is projects/{project-id}.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • pageSize int? (default ()) - Maximum number of topics to return.
  • pageToken string? (default ()) - 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.
Return Type

getTopicIAMPolicy

Isolated FunctionRemote Function
function getTopicIAMPolicy(string 'resource, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, int? optionsRequestedpolicyversion) returns Policy|error

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

Parameters
  • 'resource string - REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • optionsRequestedpolicyversion int? (default ()) - Optional. 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.
Return Type

setTopicIAMPolicy

Isolated FunctionRemote Function
function setTopicIAMPolicy(string 'resource, SetIamPolicyRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Policy|error

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters
  • 'resource string - REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

testTopicIAMPermissions

Isolated FunctionRemote Function
function testTopicIAMPermissions(string 'resource, TestIamPermissionsRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns TestIamPermissionsResponse|error

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.

Parameters
  • 'resource string - REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

getSnapshot

Isolated FunctionRemote Function
function getSnapshot(string snapshot, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Snapshot|error

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.

Parameters
  • snapshot string - Required. The name of the snapshot to get. Format is projects/{project}/snapshots/{snap}.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

deleteSnapshot

Isolated FunctionRemote Function
function deleteSnapshot(string snapshot, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

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.

Parameters
  • snapshot string - Required. The name of the snapshot to delete. Format is projects/{project}/snapshots/{snap}.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

getSubscription

Isolated FunctionRemote Function
function getSubscription(string subscription, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Subscription|error

Gets the configuration details of a subscription.

Parameters
  • subscription string - Required. The name of the subscription to get. Format is projects/{project}/subscriptions/{sub}.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

deleteSubscription

Isolated FunctionRemote Function
function deleteSubscription(string subscription, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

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.

Parameters
  • subscription string - Required. The subscription to delete. Format is projects/{project}/subscriptions/{sub}.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

acknowledgeSubscription

Isolated FunctionRemote Function
function acknowledgeSubscription(string subscription, AcknowledgeRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

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.

Parameters
  • subscription string - Required. The subscription whose message is being acknowledged. Format is projects/{project}/subscriptions/{sub}.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

detachSubscription

Isolated FunctionRemote Function
function detachSubscription(string subscription, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

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.

Parameters
  • subscription string - Required. The subscription to detach. Format is projects/{project}/subscriptions/{subscription}.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

modifySubscriptionAckDeadline

Isolated FunctionRemote Function
function modifySubscriptionAckDeadline(string subscription, ModifyAckDeadlineRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

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.

Parameters
  • subscription string - Required. The name of the subscription. Format is projects/{project}/subscriptions/{sub}.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

modifySubscriptionPushConfig

Isolated FunctionRemote Function
function modifySubscriptionPushConfig(string subscription, ModifyPushConfigRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

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.

Parameters
  • subscription string - Required. The name of the subscription. Format is projects/{project}/subscriptions/{sub}.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

pullSubscription

Isolated FunctionRemote Function
function pullSubscription(string subscription, PullRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns PullResponse|error

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

Parameters
  • subscription string - Required. The subscription from which messages should be pulled. Format is projects/{project}/subscriptions/{sub}.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

seekSubscription

Isolated FunctionRemote Function
function seekSubscription(string subscription, SeekRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

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.

Parameters
  • subscription string - Required. The subscription to affect.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

getTopic

Isolated FunctionRemote Function
function getTopic(string topic, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Topic|error

Gets the configuration of a topic.

Parameters
  • topic string - Required. The name of the topic to get. Format is projects/{project}/topics/{topic}.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

deleteTopic

Isolated FunctionRemote Function
function deleteTopic(string topic, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

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

Parameters
  • topic string - Required. Name of the topic to delete. Format is projects/{project}/topics/{topic}.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

listTopicSnapshots

Isolated FunctionRemote Function
function listTopicSnapshots(string topic, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, int? pageSize, string? pageToken) returns ListTopicSnapshotsResponse|error

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.

Parameters
  • topic string - Required. The name of the topic that snapshots are attached to. Format is projects/{project}/topics/{topic}.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • pageSize int? (default ()) - Maximum number of snapshot names to return.
  • pageToken string? (default ()) - 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.
Return Type

listTopicSubscriptions

Isolated FunctionRemote Function
function listTopicSubscriptions(string topic, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, int? pageSize, string? pageToken) returns ListTopicSubscriptionsResponse|error

Lists the names of the attached subscriptions on this topic.

Parameters
  • topic string - Required. The name of the topic that subscriptions are attached to. Format is projects/{project}/topics/{topic}.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • pageSize int? (default ()) - Maximum number of subscription names to return.
  • pageToken string? (default ()) - 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.
Return Type

publishPubsubProjectsTopic

Isolated FunctionRemote Function
function publishPubsubProjectsTopic(string topic, PublishRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns PublishResponse|error

Adds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist.

Parameters
  • topic string - Required. The messages in the request will be published on this topic. Format is projects/{project}/topics/{topic}.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

Records

googleapis.cloudpubsub: AcknowledgeRequest

Request for the Acknowledge method.

Fields
  • ackIds string[]? - 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.

googleapis.cloudpubsub: Binding

Associates members with a role.

Fields
  • condition 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.
  • members string[]? - 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.
  • role string? - Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.

googleapis.cloudpubsub: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields
  • keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
  • chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

googleapis.cloudpubsub: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields
  • httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
  • timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
  • forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header
  • cache CacheConfig? - HTTP caching related configurations
  • compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header
  • circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
  • retryConfig RetryConfig? - Configurations associated with retrying
  • validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

googleapis.cloudpubsub: CreateSnapshotRequest

Request for the CreateSnapshot method.

Fields
  • labels record {}? - See Creating and managing labels.
  • subscription string? - 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}.

googleapis.cloudpubsub: 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.

Fields
  • deadLetterTopic string? - 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.
  • maxDeliveryAttempts int? - 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.

googleapis.cloudpubsub: ExpirationPolicy

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

Fields
  • ttl string? - 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.

googleapis.cloudpubsub: 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.

Fields
  • description string? - Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
  • expression string? - Textual representation of an expression in Common Expression Language syntax.
  • location string? - Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
  • title string? - 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.

googleapis.cloudpubsub: ListSchemasResponse

Response for the ListSchemas method.

Fields
  • nextPageToken string? - If not empty, indicates that there may be more schemas that match the request; this value should be passed in a new ListSchemasRequest.
  • schemas Schema[]? - The resulting schemas.

googleapis.cloudpubsub: ListSnapshotsResponse

Response for the ListSnapshots method.

Fields
  • nextPageToken string? - If not empty, indicates that there may be more snapshot that match the request; this value should be passed in a new ListSnapshotsRequest.
  • snapshots Snapshot[]? - The resulting snapshots.

googleapis.cloudpubsub: ListSubscriptionsResponse

Response for the ListSubscriptions method.

Fields
  • nextPageToken string? - 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.
  • subscriptions Subscription[]? - The subscriptions that match the request.

googleapis.cloudpubsub: ListTopicSnapshotsResponse

Response for the ListTopicSnapshots method.

Fields
  • nextPageToken string? - 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.
  • snapshots string[]? - The names of the snapshots that match the request.

googleapis.cloudpubsub: ListTopicsResponse

Response for the ListTopics method.

Fields
  • nextPageToken string? - If not empty, indicates that there may be more topics that match the request; this value should be passed in a new ListTopicsRequest.
  • topics Topic[]? - The resulting topics.

googleapis.cloudpubsub: ListTopicSubscriptionsResponse

Response for the ListTopicSubscriptions method.

Fields
  • nextPageToken string? - 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.
  • subscriptions string[]? - The names of subscriptions attached to the topic specified in the request.

googleapis.cloudpubsub: MessageStoragePolicy

A policy constraining the storage of messages published to the topic.

Fields
  • allowedPersistenceRegions string[]? - 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.

googleapis.cloudpubsub: ModifyAckDeadlineRequest

Request for the ModifyAckDeadline method.

Fields
  • ackDeadlineSeconds int? - 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).
  • ackIds string[]? - Required. List of acknowledgment IDs.

googleapis.cloudpubsub: ModifyPushConfigRequest

Request for the ModifyPushConfig method.

Fields
  • pushConfig PushConfig? - Configuration for a push delivery endpoint.

googleapis.cloudpubsub: OAuth2RefreshTokenGrantConfig

Closed record

OAuth2 Refresh Token Grant Configs

Fields
  • refreshUrl string(default "https://accounts.google.com/o/oauth2/token") - Refresh URL

googleapis.cloudpubsub: OidcToken

Contains information needed for generating an OpenID Connect token.

Fields
  • audience string? - 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.
  • serviceAccountEmail string? - Service account email 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.

googleapis.cloudpubsub: 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. 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.

Fields
  • bindings Binding[]? - 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.
  • etag string? - 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.
  • 'version int? - 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.

googleapis.cloudpubsub: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields
  • host string(default "") - Host name of the proxy server
  • port int(default 0) - Proxy server port
  • userName string(default "") - Proxy server username
  • password string(default "") - Proxy server password

googleapis.cloudpubsub: PublishRequest

Request for the Publish method.

Fields

googleapis.cloudpubsub: PublishResponse

Response for the Publish method.

Fields
  • messageIds string[]? - 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.

googleapis.cloudpubsub: 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 for more information. See [quotas and limits] (https://cloud.google.com/pubsub/quotas) for more information about message limits.

Fields
  • attributes record {}? - 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.
  • data string? - The message data field. If this field is empty, the message must contain at least one attribute.
  • messageId string? - 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.
  • orderingKey string? - 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 PubsubMessages published in a given PublishRequest must specify the same ordering_key value.
  • publishTime string? - 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.

googleapis.cloudpubsub: PullRequest

Request for the Pull method.

Fields
  • maxMessages int? - 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.
  • returnImmediately boolean? - 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.

googleapis.cloudpubsub: PullResponse

Response for the Pull method.

Fields
  • receivedMessages ReceivedMessage[]? - 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.

googleapis.cloudpubsub: PushConfig

Configuration for a push delivery endpoint.

Fields
  • attributes record {}? - 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" }
  • pushEndpoint string? - A URL locating the endpoint to which messages should be pushed. For example, a Webhook endpoint might use https://example.com/push.

googleapis.cloudpubsub: ReceivedMessage

A message and its corresponding acknowledgment ID.

Fields
  • ackId string? - This ID can be used to acknowledge the received message.
  • deliveryAttempt int? - 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.
  • message 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 for more information. See [quotas and limits] (https://cloud.google.com/pubsub/quotas) for more information about message limits.

googleapis.cloudpubsub: 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.

Fields
  • maximumBackoff string? - The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds.
  • minimumBackoff string? - The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.

googleapis.cloudpubsub: Schema

A schema resource.

Fields
  • definition string? - 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.
  • name string? - Required. Name of the schema. Format is projects/{project}/schemas/{schema}.
  • 'type string? - The type of the schema definition.

googleapis.cloudpubsub: SchemaSettings

Settings for validating messages published against a schema.

Fields
  • encoding string? - The encoding of messages validated against schema.
  • schema string? - 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.

googleapis.cloudpubsub: SeekRequest

Request for the Seek method.

Fields
  • snapshot string? - 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}.
  • time string? - 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.

googleapis.cloudpubsub: SetIamPolicyRequest

Request message for SetIamPolicy method.

Fields
  • policy 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. 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.

googleapis.cloudpubsub: Snapshot

A snapshot resource. 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.

Fields
  • expireTime string? - 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.
  • labels record {}? - See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
  • name string? - The name of the snapshot.
  • topic string? - The name of the topic from which this snapshot is retaining messages.

googleapis.cloudpubsub: Subscription

A subscription resource.

Fields
  • ackDeadlineSeconds int? - 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.
  • deadLetterPolicy 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.
  • detached boolean? - 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.
  • enableMessageOrdering boolean? - 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.
  • expirationPolicy ExpirationPolicy? - A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion).
  • filter string? - An expression written in the Pub/Sub filter language. If non-empty, then only PubsubMessages whose attributes field matches the filter are delivered on this subscription. If empty, then no messages are filtered out.
  • labels record {}? - See Creating and managing labels.
  • messageRetentionDuration string? - 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.
  • name string? - 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".
  • pushConfig PushConfig? - Configuration for a push delivery endpoint.
  • retainAckedMessages boolean? - 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) in the past to replay previously-acknowledged messages.
  • retryPolicy 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.
  • topic string? - 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.
  • topicMessageRetentionDuration string? - Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last topic_message_retention_duration are always available to subscribers. See the message_retention_duration field in Topic. This field is set only in responses from the server; it is ignored if it is set in any requests.

googleapis.cloudpubsub: TestIamPermissionsRequest

Request message for TestIamPermissions method.

Fields
  • permissions string[]? - 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.

googleapis.cloudpubsub: TestIamPermissionsResponse

Response message for TestIamPermissions method.

Fields
  • permissions string[]? - A subset of TestPermissionsRequest.permissions that the caller is allowed.

googleapis.cloudpubsub: Topic

A topic resource.

Fields
  • kmsKeyName string? - 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/*.
  • labels record {}? - See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels).
  • messageRetentionDuration string? - Indicates the minimum duration to retain a message after it is published to the topic. If this field is set, messages published to the topic in the last message_retention_duration are always available to subscribers. For instance, it allows any attached subscription to seek to a timestamp that is up to message_retention_duration in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. Cannot be more than 7 days or less than 10 minutes.
  • messageStoragePolicy MessageStoragePolicy? - A policy constraining the storage of messages published to the topic.
  • name string? - 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".
  • satisfiesPzs boolean? - Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
  • schemaSettings SchemaSettings? - Settings for validating messages published against a schema.

googleapis.cloudpubsub: UpdateSnapshotRequest

Request for the UpdateSnapshot method.

Fields
  • snapshot Snapshot? - A snapshot resource. 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.
  • updateMask string? - Required. Indicates which fields in the provided snapshot to update. Must be specified and non-empty.

googleapis.cloudpubsub: UpdateSubscriptionRequest

Request for the UpdateSubscription method.

Fields
  • updateMask string? - Required. Indicates which fields in the provided subscription to update. Must be specified and non-empty.

googleapis.cloudpubsub: UpdateTopicRequest

Request for the UpdateTopic method.

Fields
  • topic Topic? - A topic resource.
  • updateMask string? - 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.

googleapis.cloudpubsub: ValidateMessageRequest

Request for the ValidateMessage method.

Fields
  • encoding string? - The encoding expected for messages
  • message string? - Message to validate against the provided schema_spec.
  • name string? - Name of the schema against which to validate. Format is projects/{project}/schemas/{schema}.
  • schema Schema? - A schema resource.

googleapis.cloudpubsub: ValidateSchemaRequest

Request for the ValidateSchema method.

Fields
  • schema Schema? - A schema resource.

Import

import ballerinax/googleapis.cloudpubsub;Copy

Metadata

Released date: over 1 year ago

Version: 1.5.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 5

Current verison: 5

Weekly downloads

Source repository

Keywords

IT Operations/Data Ingestion

Cost/Freemium

Vendor/Google

Contributors

Other versions

1.5.1

1.5.01.4.01.2.01.1.0
See more...

Dependencies

ballerina/url/2.2.3ballerina/http/2.6.1

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2025 WSO2 LLC