814 lines
37 KiB
Ruby
814 lines
37 KiB
Ruby
# Copyright 2020 Google LLC
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
require 'date'
|
|
require 'google/apis/core/base_service'
|
|
require 'google/apis/core/json_representation'
|
|
require 'google/apis/core/hashable'
|
|
require 'google/apis/errors'
|
|
|
|
module Google
|
|
module Apis
|
|
module PubsubV1beta2
|
|
|
|
# Request for the Acknowledge method.
|
|
class AcknowledgeRequest
|
|
include Google::Apis::Core::Hashable
|
|
|
|
# The acknowledgment ID for the messages being acknowledged that was returned by
|
|
# the Pub/Sub system in the `Pull` response. Must not be empty.
|
|
# Corresponds to the JSON property `ackIds`
|
|
# @return [Array<String>]
|
|
attr_accessor :ack_ids
|
|
|
|
def initialize(**args)
|
|
update!(**args)
|
|
end
|
|
|
|
# Update properties of this object
|
|
def update!(**args)
|
|
@ack_ids = args[:ack_ids] if args.key?(:ack_ids)
|
|
end
|
|
end
|
|
|
|
# Associates `members` with a `role`.
|
|
class Binding
|
|
include Google::Apis::Core::Hashable
|
|
|
|
# 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.
|
|
# Corresponds to the JSON property `condition`
|
|
# @return [Google::Apis::PubsubV1beta2::Expr]
|
|
attr_accessor :condition
|
|
|
|
# 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`.
|
|
# Corresponds to the JSON property `members`
|
|
# @return [Array<String>]
|
|
attr_accessor :members
|
|
|
|
# Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`
|
|
# , or `roles/owner`.
|
|
# Corresponds to the JSON property `role`
|
|
# @return [String]
|
|
attr_accessor :role
|
|
|
|
def initialize(**args)
|
|
update!(**args)
|
|
end
|
|
|
|
# Update properties of this object
|
|
def update!(**args)
|
|
@condition = args[:condition] if args.key?(:condition)
|
|
@members = args[:members] if args.key?(:members)
|
|
@role = args[:role] if args.key?(:role)
|
|
end
|
|
end
|
|
|
|
# A generic empty message that you can re-use to avoid defining duplicated empty
|
|
# messages in your APIs. A typical example is to use it as the request or the
|
|
# response type of an API method. For instance: service Foo ` rpc Bar(google.
|
|
# protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
|
|
# `Empty` is empty JSON object ````.
|
|
class Empty
|
|
include Google::Apis::Core::Hashable
|
|
|
|
def initialize(**args)
|
|
update!(**args)
|
|
end
|
|
|
|
# Update properties of this object
|
|
def update!(**args)
|
|
end
|
|
end
|
|
|
|
# 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.
|
|
class Expr
|
|
include Google::Apis::Core::Hashable
|
|
|
|
# Optional. Description of the expression. This is a longer text which describes
|
|
# the expression, e.g. when hovered over it in a UI.
|
|
# Corresponds to the JSON property `description`
|
|
# @return [String]
|
|
attr_accessor :description
|
|
|
|
# Textual representation of an expression in Common Expression Language syntax.
|
|
# Corresponds to the JSON property `expression`
|
|
# @return [String]
|
|
attr_accessor :expression
|
|
|
|
# Optional. String indicating the location of the expression for error reporting,
|
|
# e.g. a file name and a position in the file.
|
|
# Corresponds to the JSON property `location`
|
|
# @return [String]
|
|
attr_accessor :location
|
|
|
|
# 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.
|
|
# Corresponds to the JSON property `title`
|
|
# @return [String]
|
|
attr_accessor :title
|
|
|
|
def initialize(**args)
|
|
update!(**args)
|
|
end
|
|
|
|
# Update properties of this object
|
|
def update!(**args)
|
|
@description = args[:description] if args.key?(:description)
|
|
@expression = args[:expression] if args.key?(:expression)
|
|
@location = args[:location] if args.key?(:location)
|
|
@title = args[:title] if args.key?(:title)
|
|
end
|
|
end
|
|
|
|
# Response for the `ListSubscriptions` method.
|
|
class ListSubscriptionsResponse
|
|
include Google::Apis::Core::Hashable
|
|
|
|
# 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.
|
|
# Corresponds to the JSON property `nextPageToken`
|
|
# @return [String]
|
|
attr_accessor :next_page_token
|
|
|
|
# The subscriptions that match the request.
|
|
# Corresponds to the JSON property `subscriptions`
|
|
# @return [Array<Google::Apis::PubsubV1beta2::Subscription>]
|
|
attr_accessor :subscriptions
|
|
|
|
def initialize(**args)
|
|
update!(**args)
|
|
end
|
|
|
|
# Update properties of this object
|
|
def update!(**args)
|
|
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
|
@subscriptions = args[:subscriptions] if args.key?(:subscriptions)
|
|
end
|
|
end
|
|
|
|
# Response for the `ListTopicSubscriptions` method.
|
|
class ListTopicSubscriptionsResponse
|
|
include Google::Apis::Core::Hashable
|
|
|
|
# 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.
|
|
# Corresponds to the JSON property `nextPageToken`
|
|
# @return [String]
|
|
attr_accessor :next_page_token
|
|
|
|
# The names of the subscriptions that match the request.
|
|
# Corresponds to the JSON property `subscriptions`
|
|
# @return [Array<String>]
|
|
attr_accessor :subscriptions
|
|
|
|
def initialize(**args)
|
|
update!(**args)
|
|
end
|
|
|
|
# Update properties of this object
|
|
def update!(**args)
|
|
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
|
@subscriptions = args[:subscriptions] if args.key?(:subscriptions)
|
|
end
|
|
end
|
|
|
|
# Response for the `ListTopics` method.
|
|
class ListTopicsResponse
|
|
include Google::Apis::Core::Hashable
|
|
|
|
# If not empty, indicates that there may be more topics that match the request;
|
|
# this value should be passed in a new `ListTopicsRequest`.
|
|
# Corresponds to the JSON property `nextPageToken`
|
|
# @return [String]
|
|
attr_accessor :next_page_token
|
|
|
|
# The resulting topics.
|
|
# Corresponds to the JSON property `topics`
|
|
# @return [Array<Google::Apis::PubsubV1beta2::Topic>]
|
|
attr_accessor :topics
|
|
|
|
def initialize(**args)
|
|
update!(**args)
|
|
end
|
|
|
|
# Update properties of this object
|
|
def update!(**args)
|
|
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
|
|
@topics = args[:topics] if args.key?(:topics)
|
|
end
|
|
end
|
|
|
|
# Request for the ModifyAckDeadline method.
|
|
class ModifyAckDeadlineRequest
|
|
include Google::Apis::Core::Hashable
|
|
|
|
# The new ack deadline with respect to the time this request was sent to the Pub/
|
|
# Sub system. Must be >= 0. For example, if the value is 10, the new ack
|
|
# deadline will expire 10 seconds after the `ModifyAckDeadline` call was made.
|
|
# Specifying zero may immediately make the message available for another pull
|
|
# request.
|
|
# Corresponds to the JSON property `ackDeadlineSeconds`
|
|
# @return [Fixnum]
|
|
attr_accessor :ack_deadline_seconds
|
|
|
|
# The acknowledgment ID. Either this or ack_ids must be populated, but not both.
|
|
# Corresponds to the JSON property `ackId`
|
|
# @return [String]
|
|
attr_accessor :ack_id
|
|
|
|
# List of acknowledgment IDs.
|
|
# Corresponds to the JSON property `ackIds`
|
|
# @return [Array<String>]
|
|
attr_accessor :ack_ids
|
|
|
|
def initialize(**args)
|
|
update!(**args)
|
|
end
|
|
|
|
# Update properties of this object
|
|
def update!(**args)
|
|
@ack_deadline_seconds = args[:ack_deadline_seconds] if args.key?(:ack_deadline_seconds)
|
|
@ack_id = args[:ack_id] if args.key?(:ack_id)
|
|
@ack_ids = args[:ack_ids] if args.key?(:ack_ids)
|
|
end
|
|
end
|
|
|
|
# Request for the ModifyPushConfig method.
|
|
class ModifyPushConfigRequest
|
|
include Google::Apis::Core::Hashable
|
|
|
|
# Configuration for a push delivery endpoint.
|
|
# Corresponds to the JSON property `pushConfig`
|
|
# @return [Google::Apis::PubsubV1beta2::PushConfig]
|
|
attr_accessor :push_config
|
|
|
|
def initialize(**args)
|
|
update!(**args)
|
|
end
|
|
|
|
# Update properties of this object
|
|
def update!(**args)
|
|
@push_config = args[:push_config] if args.key?(:push_config)
|
|
end
|
|
end
|
|
|
|
# Contains information needed for generating an [OpenID Connect token](https://
|
|
# developers.google.com/identity/protocols/OpenIDConnect).
|
|
class OidcToken
|
|
include Google::Apis::Core::Hashable
|
|
|
|
# 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.
|
|
# Corresponds to the JSON property `audience`
|
|
# @return [String]
|
|
attr_accessor :audience
|
|
|
|
# [Service account email](https://cloud.google.com/iam/docs/service-accounts) to
|
|
# be used for generating the OIDC token. The caller (for CreateSubscription,
|
|
# UpdateSubscription, and ModifyPushConfig RPCs) must have the iam.
|
|
# serviceAccounts.actAs permission for the service account.
|
|
# Corresponds to the JSON property `serviceAccountEmail`
|
|
# @return [String]
|
|
attr_accessor :service_account_email
|
|
|
|
def initialize(**args)
|
|
update!(**args)
|
|
end
|
|
|
|
# Update properties of this object
|
|
def update!(**args)
|
|
@audience = args[:audience] if args.key?(:audience)
|
|
@service_account_email = args[:service_account_email] if args.key?(:service_account_email)
|
|
end
|
|
end
|
|
|
|
# An Identity and Access Management (IAM) policy, which specifies access
|
|
# controls for Google Cloud resources. A `Policy` is a collection of `bindings`.
|
|
# A `binding` binds one or more `members` to a single `role`. Members can be
|
|
# user accounts, service accounts, Google groups, and domains (such as G Suite).
|
|
# A `role` is a named list of permissions; each `role` can be an IAM predefined
|
|
# role or a user-created custom role. For some types of Google Cloud resources,
|
|
# a `binding` can also specify a `condition`, which is a logical expression that
|
|
# allows access to a resource only if the expression evaluates to `true`. A
|
|
# condition can add constraints based on attributes of the request, the resource,
|
|
# or both. To learn which resources support conditions in their IAM policies,
|
|
# see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
|
|
# resource-policies). **JSON example:** ` "bindings": [ ` "role": "roles/
|
|
# resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "
|
|
# group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@
|
|
# appspot.gserviceaccount.com" ] `, ` "role": "roles/resourcemanager.
|
|
# organizationViewer", "members": [ "user:eve@example.com" ], "condition": ` "
|
|
# title": "expirable access", "description": "Does not grant access after Sep
|
|
# 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", `
|
|
# ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:** bindings: -
|
|
# members: - user:mike@example.com - group:admins@example.com - domain:google.
|
|
# com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/
|
|
# resourcemanager.organizationAdmin - members: - user:eve@example.com role:
|
|
# roles/resourcemanager.organizationViewer condition: title: expirable access
|
|
# description: Does not grant access after Sep 2020 expression: request.time <
|
|
# timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a
|
|
# description of IAM and its features, see the [IAM documentation](https://cloud.
|
|
# google.com/iam/docs/).
|
|
class Policy
|
|
include Google::Apis::Core::Hashable
|
|
|
|
# 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.
|
|
# Corresponds to the JSON property `bindings`
|
|
# @return [Array<Google::Apis::PubsubV1beta2::Binding>]
|
|
attr_accessor :bindings
|
|
|
|
# `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.
|
|
# Corresponds to the JSON property `etag`
|
|
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
|
# @return [String]
|
|
attr_accessor :etag
|
|
|
|
# Specifies the format of the policy. Valid values are `0`, `1`, and `3`.
|
|
# Requests that specify an invalid value are rejected. Any operation that
|
|
# affects conditional role bindings must specify version `3`. This requirement
|
|
# applies to the following operations: * Getting a policy that includes a
|
|
# conditional role binding * Adding a conditional role binding to a policy *
|
|
# Changing a conditional role binding in a policy * Removing any role binding,
|
|
# with or without a condition, from a policy that includes conditions **
|
|
# Important:** If you use IAM Conditions, you must include the `etag` field
|
|
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows you
|
|
# to overwrite a version `3` policy with a version `1` policy, and all of the
|
|
# conditions in the version `3` policy are lost. If a policy does not include
|
|
# any conditions, operations on that policy may specify any valid version or
|
|
# leave the field unset. To learn which resources support conditions in their
|
|
# IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/
|
|
# conditions/resource-policies).
|
|
# Corresponds to the JSON property `version`
|
|
# @return [Fixnum]
|
|
attr_accessor :version
|
|
|
|
def initialize(**args)
|
|
update!(**args)
|
|
end
|
|
|
|
# Update properties of this object
|
|
def update!(**args)
|
|
@bindings = args[:bindings] if args.key?(:bindings)
|
|
@etag = args[:etag] if args.key?(:etag)
|
|
@version = args[:version] if args.key?(:version)
|
|
end
|
|
end
|
|
|
|
# Request for the Publish method.
|
|
class PublishRequest
|
|
include Google::Apis::Core::Hashable
|
|
|
|
# The messages to publish.
|
|
# Corresponds to the JSON property `messages`
|
|
# @return [Array<Google::Apis::PubsubV1beta2::PubsubMessage>]
|
|
attr_accessor :messages
|
|
|
|
def initialize(**args)
|
|
update!(**args)
|
|
end
|
|
|
|
# Update properties of this object
|
|
def update!(**args)
|
|
@messages = args[:messages] if args.key?(:messages)
|
|
end
|
|
end
|
|
|
|
# Response for the `Publish` method.
|
|
class PublishResponse
|
|
include Google::Apis::Core::Hashable
|
|
|
|
# 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.
|
|
# Corresponds to the JSON property `messageIds`
|
|
# @return [Array<String>]
|
|
attr_accessor :message_ids
|
|
|
|
def initialize(**args)
|
|
update!(**args)
|
|
end
|
|
|
|
# Update properties of this object
|
|
def update!(**args)
|
|
@message_ids = args[:message_ids] if args.key?(:message_ids)
|
|
end
|
|
end
|
|
|
|
# A message data and its attributes. The message payload must not be empty; it
|
|
# must contain either a non-empty data field, or at least one attribute.
|
|
class PubsubMessage
|
|
include Google::Apis::Core::Hashable
|
|
|
|
# Optional attributes for this message.
|
|
# Corresponds to the JSON property `attributes`
|
|
# @return [Hash<String,String>]
|
|
attr_accessor :attributes
|
|
|
|
# The message payload. For JSON requests, the value of this field must be [
|
|
# base64-encoded](https://tools.ietf.org/html/rfc4648).
|
|
# Corresponds to the JSON property `data`
|
|
# NOTE: Values are automatically base64 encoded/decoded in the client library.
|
|
# @return [String]
|
|
attr_accessor :data
|
|
|
|
# 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.
|
|
# Corresponds to the JSON property `messageId`
|
|
# @return [String]
|
|
attr_accessor :message_id
|
|
|
|
# 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.
|
|
# Corresponds to the JSON property `publishTime`
|
|
# @return [String]
|
|
attr_accessor :publish_time
|
|
|
|
def initialize(**args)
|
|
update!(**args)
|
|
end
|
|
|
|
# Update properties of this object
|
|
def update!(**args)
|
|
@attributes = args[:attributes] if args.key?(:attributes)
|
|
@data = args[:data] if args.key?(:data)
|
|
@message_id = args[:message_id] if args.key?(:message_id)
|
|
@publish_time = args[:publish_time] if args.key?(:publish_time)
|
|
end
|
|
end
|
|
|
|
# Request for the `Pull` method.
|
|
class PullRequest
|
|
include Google::Apis::Core::Hashable
|
|
|
|
# The maximum number of messages returned for this request. The Pub/Sub system
|
|
# may return fewer than the number specified.
|
|
# Corresponds to the JSON property `maxMessages`
|
|
# @return [Fixnum]
|
|
attr_accessor :max_messages
|
|
|
|
# Optional. If this is specified as true the system will respond immediately
|
|
# even if it is not able to return a message in the `Pull` response. Otherwise
|
|
# the system is allowed to wait until at least one message is available rather
|
|
# than returning no messages. The client may cancel the request if it does not
|
|
# wish to wait any longer for the response. 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.
|
|
# Corresponds to the JSON property `returnImmediately`
|
|
# @return [Boolean]
|
|
attr_accessor :return_immediately
|
|
alias_method :return_immediately?, :return_immediately
|
|
|
|
def initialize(**args)
|
|
update!(**args)
|
|
end
|
|
|
|
# Update properties of this object
|
|
def update!(**args)
|
|
@max_messages = args[:max_messages] if args.key?(:max_messages)
|
|
@return_immediately = args[:return_immediately] if args.key?(:return_immediately)
|
|
end
|
|
end
|
|
|
|
# Response for the `Pull` method.
|
|
class PullResponse
|
|
include Google::Apis::Core::Hashable
|
|
|
|
# Received Pub/Sub messages. The Pub/Sub system will return zero messages if
|
|
# there are no more available in the backlog. The Pub/Sub system may return
|
|
# fewer than the `maxMessages` requested even if there are more messages
|
|
# available in the backlog.
|
|
# Corresponds to the JSON property `receivedMessages`
|
|
# @return [Array<Google::Apis::PubsubV1beta2::ReceivedMessage>]
|
|
attr_accessor :received_messages
|
|
|
|
def initialize(**args)
|
|
update!(**args)
|
|
end
|
|
|
|
# Update properties of this object
|
|
def update!(**args)
|
|
@received_messages = args[:received_messages] if args.key?(:received_messages)
|
|
end
|
|
end
|
|
|
|
# Configuration for a push delivery endpoint.
|
|
class PushConfig
|
|
include Google::Apis::Core::Hashable
|
|
|
|
# Endpoint configuration attributes. Every endpoint has a set of API supported
|
|
# attributes that can be used to control different aspects of the message
|
|
# delivery. The currently supported attribute is `x-goog-version`, which you can
|
|
# use to change the format of the push message. This attribute indicates the
|
|
# version of the data expected by the endpoint. This controls the shape of the
|
|
# envelope (i.e. its fields and metadata). The endpoint version is based on the
|
|
# version of the Pub/Sub API. If not present during the `CreateSubscription`
|
|
# call, it will default to the version of the API used to make such call. If not
|
|
# present during a `ModifyPushConfig` call, its value will not be changed. `
|
|
# GetSubscription` calls will always return a valid version, even if the
|
|
# subscription was created without this attribute. The possible values for this
|
|
# attribute are: * `v1beta1`: uses the push format defined in the v1beta1 Pub/
|
|
# Sub API. * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub
|
|
# API.
|
|
# Corresponds to the JSON property `attributes`
|
|
# @return [Hash<String,String>]
|
|
attr_accessor :attributes
|
|
|
|
# Contains information needed for generating an [OpenID Connect token](https://
|
|
# developers.google.com/identity/protocols/OpenIDConnect).
|
|
# Corresponds to the JSON property `oidcToken`
|
|
# @return [Google::Apis::PubsubV1beta2::OidcToken]
|
|
attr_accessor :oidc_token
|
|
|
|
# A URL locating the endpoint to which messages should be pushed. For example, a
|
|
# Webhook endpoint might use "https://example.com/push".
|
|
# Corresponds to the JSON property `pushEndpoint`
|
|
# @return [String]
|
|
attr_accessor :push_endpoint
|
|
|
|
def initialize(**args)
|
|
update!(**args)
|
|
end
|
|
|
|
# Update properties of this object
|
|
def update!(**args)
|
|
@attributes = args[:attributes] if args.key?(:attributes)
|
|
@oidc_token = args[:oidc_token] if args.key?(:oidc_token)
|
|
@push_endpoint = args[:push_endpoint] if args.key?(:push_endpoint)
|
|
end
|
|
end
|
|
|
|
# A message and its corresponding acknowledgment ID.
|
|
class ReceivedMessage
|
|
include Google::Apis::Core::Hashable
|
|
|
|
# This ID can be used to acknowledge the received message.
|
|
# Corresponds to the JSON property `ackId`
|
|
# @return [String]
|
|
attr_accessor :ack_id
|
|
|
|
# A message data and its attributes. The message payload must not be empty; it
|
|
# must contain either a non-empty data field, or at least one attribute.
|
|
# Corresponds to the JSON property `message`
|
|
# @return [Google::Apis::PubsubV1beta2::PubsubMessage]
|
|
attr_accessor :message
|
|
|
|
def initialize(**args)
|
|
update!(**args)
|
|
end
|
|
|
|
# Update properties of this object
|
|
def update!(**args)
|
|
@ack_id = args[:ack_id] if args.key?(:ack_id)
|
|
@message = args[:message] if args.key?(:message)
|
|
end
|
|
end
|
|
|
|
# Request message for `SetIamPolicy` method.
|
|
class SetIamPolicyRequest
|
|
include Google::Apis::Core::Hashable
|
|
|
|
# An Identity and Access Management (IAM) policy, which specifies access
|
|
# controls for Google Cloud resources. A `Policy` is a collection of `bindings`.
|
|
# A `binding` binds one or more `members` to a single `role`. Members can be
|
|
# user accounts, service accounts, Google groups, and domains (such as G Suite).
|
|
# A `role` is a named list of permissions; each `role` can be an IAM predefined
|
|
# role or a user-created custom role. For some types of Google Cloud resources,
|
|
# a `binding` can also specify a `condition`, which is a logical expression that
|
|
# allows access to a resource only if the expression evaluates to `true`. A
|
|
# condition can add constraints based on attributes of the request, the resource,
|
|
# or both. To learn which resources support conditions in their IAM policies,
|
|
# see the [IAM documentation](https://cloud.google.com/iam/help/conditions/
|
|
# resource-policies). **JSON example:** ` "bindings": [ ` "role": "roles/
|
|
# resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "
|
|
# group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@
|
|
# appspot.gserviceaccount.com" ] `, ` "role": "roles/resourcemanager.
|
|
# organizationViewer", "members": [ "user:eve@example.com" ], "condition": ` "
|
|
# title": "expirable access", "description": "Does not grant access after Sep
|
|
# 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", `
|
|
# ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:** bindings: -
|
|
# members: - user:mike@example.com - group:admins@example.com - domain:google.
|
|
# com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/
|
|
# resourcemanager.organizationAdmin - members: - user:eve@example.com role:
|
|
# roles/resourcemanager.organizationViewer condition: title: expirable access
|
|
# description: Does not grant access after Sep 2020 expression: request.time <
|
|
# timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a
|
|
# description of IAM and its features, see the [IAM documentation](https://cloud.
|
|
# google.com/iam/docs/).
|
|
# Corresponds to the JSON property `policy`
|
|
# @return [Google::Apis::PubsubV1beta2::Policy]
|
|
attr_accessor :policy
|
|
|
|
def initialize(**args)
|
|
update!(**args)
|
|
end
|
|
|
|
# Update properties of this object
|
|
def update!(**args)
|
|
@policy = args[:policy] if args.key?(:policy)
|
|
end
|
|
end
|
|
|
|
# A subscription resource.
|
|
class Subscription
|
|
include Google::Apis::Core::Hashable
|
|
|
|
# This value is the maximum time after a subscriber receives a message before
|
|
# the subscriber should acknowledge the message. After message delivery but
|
|
# before the ack deadline expires and before the message is acknowledged, it is
|
|
# an outstanding message and will not be delivered again during that time (on a
|
|
# best-effort basis). For pull 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 pull. The maximum
|
|
# custom deadline you can specify is 600 seconds (10 minutes). For push delivery,
|
|
# this value is also used to set the request timeout for the call to the push
|
|
# endpoint. If the subscriber never acknowledges the message, the Pub/Sub system
|
|
# will eventually redeliver the message. If this parameter is 0, a default value
|
|
# of 10 seconds is used.
|
|
# Corresponds to the JSON property `ackDeadlineSeconds`
|
|
# @return [Fixnum]
|
|
attr_accessor :ack_deadline_seconds
|
|
|
|
# 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"`.
|
|
# Corresponds to the JSON property `name`
|
|
# @return [String]
|
|
attr_accessor :name
|
|
|
|
# Configuration for a push delivery endpoint.
|
|
# Corresponds to the JSON property `pushConfig`
|
|
# @return [Google::Apis::PubsubV1beta2::PushConfig]
|
|
attr_accessor :push_config
|
|
|
|
# The name of the topic from which this subscription is receiving messages. The
|
|
# value of this field will be `_deleted-topic_` if the topic has been deleted.
|
|
# Corresponds to the JSON property `topic`
|
|
# @return [String]
|
|
attr_accessor :topic
|
|
|
|
def initialize(**args)
|
|
update!(**args)
|
|
end
|
|
|
|
# Update properties of this object
|
|
def update!(**args)
|
|
@ack_deadline_seconds = args[:ack_deadline_seconds] if args.key?(:ack_deadline_seconds)
|
|
@name = args[:name] if args.key?(:name)
|
|
@push_config = args[:push_config] if args.key?(:push_config)
|
|
@topic = args[:topic] if args.key?(:topic)
|
|
end
|
|
end
|
|
|
|
# Request message for `TestIamPermissions` method.
|
|
class TestIamPermissionsRequest
|
|
include Google::Apis::Core::Hashable
|
|
|
|
# The set of permissions to check for the `resource`. Permissions with wildcards
|
|
# (such as '*' or 'storage.*') are not allowed. For more information see [IAM
|
|
# Overview](https://cloud.google.com/iam/docs/overview#permissions).
|
|
# Corresponds to the JSON property `permissions`
|
|
# @return [Array<String>]
|
|
attr_accessor :permissions
|
|
|
|
def initialize(**args)
|
|
update!(**args)
|
|
end
|
|
|
|
# Update properties of this object
|
|
def update!(**args)
|
|
@permissions = args[:permissions] if args.key?(:permissions)
|
|
end
|
|
end
|
|
|
|
# Response message for `TestIamPermissions` method.
|
|
class TestIamPermissionsResponse
|
|
include Google::Apis::Core::Hashable
|
|
|
|
# A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
|
|
# Corresponds to the JSON property `permissions`
|
|
# @return [Array<String>]
|
|
attr_accessor :permissions
|
|
|
|
def initialize(**args)
|
|
update!(**args)
|
|
end
|
|
|
|
# Update properties of this object
|
|
def update!(**args)
|
|
@permissions = args[:permissions] if args.key?(:permissions)
|
|
end
|
|
end
|
|
|
|
# A topic resource.
|
|
class Topic
|
|
include Google::Apis::Core::Hashable
|
|
|
|
# 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"`.
|
|
# Corresponds to the JSON property `name`
|
|
# @return [String]
|
|
attr_accessor :name
|
|
|
|
def initialize(**args)
|
|
update!(**args)
|
|
end
|
|
|
|
# Update properties of this object
|
|
def update!(**args)
|
|
@name = args[:name] if args.key?(:name)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|