2015-12-03 01:10:07 +00:00
|
|
|
# Copyright 2015 Google Inc.
|
|
|
|
|
#
|
|
|
|
|
# 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 '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 PubsubV1
|
2018-04-11 00:35:27 +00:00
|
|
|
# Cloud Pub/Sub API
|
2015-12-03 01:10:07 +00:00
|
|
|
#
|
|
|
|
|
# Provides reliable, many-to-many, asynchronous messaging between applications.
|
|
|
|
|
#
|
|
|
|
|
# @example
|
|
|
|
|
# require 'google/apis/pubsub_v1'
|
|
|
|
|
#
|
|
|
|
|
# Pubsub = Google::Apis::PubsubV1 # Alias the module
|
|
|
|
|
# service = Pubsub::PubsubService.new
|
|
|
|
|
#
|
|
|
|
|
# @see https://cloud.google.com/pubsub/docs
|
|
|
|
|
class PubsubService < Google::Apis::Core::BaseService
|
|
|
|
|
# @return [String]
|
|
|
|
|
# API key. Your API key identifies your project and provides you with API access,
|
|
|
|
|
# quota, and reports. Required unless you provide an OAuth 2.0 token.
|
|
|
|
|
attr_accessor :key
|
|
|
|
|
|
|
|
|
|
# @return [String]
|
|
|
|
|
# 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.
|
|
|
|
|
attr_accessor :quota_user
|
|
|
|
|
|
|
|
|
|
def initialize
|
|
|
|
|
super('https://pubsub.googleapis.com/', '')
|
2017-04-03 20:18:48 +00:00
|
|
|
@batch_path = 'batch'
|
2015-12-03 01:10:07 +00:00
|
|
|
end
|
|
|
|
|
|
2020-08-14 00:38:12 +00:00
|
|
|
# Creates a snapshot from the requested subscription. Snapshots are used in [
|
|
|
|
|
# Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, which
|
|
|
|
|
# allow you to manage message acknowledgments in bulk. That is, you can set the
|
|
|
|
|
# acknowledgment state of messages in an existing subscription to the state
|
|
|
|
|
# captured by a snapshot. If the snapshot already exists, returns `
|
|
|
|
|
# ALREADY_EXISTS`. If the requested subscription doesn't exist, returns `
|
|
|
|
|
# NOT_FOUND`. If the backlog in the subscription is too old -- and the resulting
|
|
|
|
|
# snapshot would expire in less than 1 hour -- then `FAILED_PRECONDITION` is
|
|
|
|
|
# returned. See also the `Snapshot.expire_time` field. If the name is not
|
|
|
|
|
# provided in the request, the server will assign a random name for this
|
|
|
|
|
# snapshot on the same project as the subscription, conforming to the [resource
|
|
|
|
|
# name format] (https://cloud.google.com/pubsub/docs/admin#resource_names). The
|
2019-04-25 00:37:02 +00:00
|
|
|
# generated name is populated in the returned Snapshot object. Note that for
|
|
|
|
|
# REST API requests, you must specify a name in the request.
|
2017-12-02 00:36:26 +00:00
|
|
|
# @param [String] name
|
2020-02-29 00:38:29 +00:00
|
|
|
# Required. User-provided name for this snapshot. If the name is not provided in
|
2020-08-14 00:38:12 +00:00
|
|
|
# the request, the server will assign a random name for this snapshot on the
|
|
|
|
|
# same project as the subscription. Note that for REST API requests, you must
|
|
|
|
|
# specify a name. See the resource name rules. Format is `projects/`project`/
|
|
|
|
|
# snapshots/`snap``.
|
2017-12-02 00:36:26 +00:00
|
|
|
# @param [Google::Apis::PubsubV1::CreateSnapshotRequest] create_snapshot_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::Snapshot] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::PubsubV1::Snapshot]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def create_snapshot(name, create_snapshot_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:put, 'v1/{+name}', options)
|
2017-12-02 00:36:26 +00:00
|
|
|
command.request_representation = Google::Apis::PubsubV1::CreateSnapshotRequest::Representation
|
|
|
|
|
command.request_object = create_snapshot_request_object
|
|
|
|
|
command.response_representation = Google::Apis::PubsubV1::Snapshot::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::Snapshot
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2020-08-14 00:38:12 +00:00
|
|
|
# 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.
|
2017-12-02 00:36:26 +00:00
|
|
|
# @param [String] snapshot
|
2020-08-14 00:38:12 +00:00
|
|
|
# Required. The name of the snapshot to delete. Format is `projects/`project`/
|
|
|
|
|
# snapshots/`snap``.
|
2017-12-02 00:36:26 +00:00
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::Empty] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::PubsubV1::Empty]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def delete_project_snapshot(snapshot, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:delete, 'v1/{+snapshot}', options)
|
2017-12-02 00:36:26 +00:00
|
|
|
command.response_representation = Google::Apis::PubsubV1::Empty::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::Empty
|
|
|
|
|
command.params['snapshot'] = snapshot unless snapshot.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2018-01-10 00:35:52 +00:00
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2020-08-14 00:38:12 +00:00
|
|
|
# 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.
|
2018-01-10 00:35:52 +00:00
|
|
|
# @param [String] snapshot
|
2020-08-14 00:38:12 +00:00
|
|
|
# Required. The name of the snapshot to get. Format is `projects/`project`/
|
|
|
|
|
# snapshots/`snap``.
|
2018-01-10 00:35:52 +00:00
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::Snapshot] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::PubsubV1::Snapshot]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def get_project_snapshot(snapshot, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:get, 'v1/{+snapshot}', options)
|
2018-01-10 00:35:52 +00:00
|
|
|
command.response_representation = Google::Apis::PubsubV1::Snapshot::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::Snapshot
|
|
|
|
|
command.params['snapshot'] = snapshot unless snapshot.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2017-12-02 00:36:26 +00:00
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2020-08-14 00:38:12 +00:00
|
|
|
# Gets the access control policy for a resource. Returns an empty policy if the
|
|
|
|
|
# resource exists and does not have a policy set.
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [String] resource
|
2020-08-14 00:38:12 +00:00
|
|
|
# REQUIRED: The resource for which the policy is being requested. See the
|
|
|
|
|
# operation documentation for the appropriate value for this field.
|
2019-07-12 00:38:14 +00:00
|
|
|
# @param [Fixnum] options_requested_policy_version
|
2020-08-14 00:38:12 +00:00
|
|
|
# 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](https://cloud.google.com/iam/help/conditions/
|
|
|
|
|
# resource-policies).
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::Policy] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::PubsubV1::Policy]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2019-07-12 00:38:14 +00:00
|
|
|
def get_project_snapshot_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
|
2017-08-25 19:54:22 +00:00
|
|
|
command.response_representation = Google::Apis::PubsubV1::Policy::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::Policy
|
|
|
|
|
command.params['resource'] = resource unless resource.nil?
|
2019-07-12 00:38:14 +00:00
|
|
|
command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
|
2017-08-25 19:54:22 +00:00
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2020-08-14 00:38:12 +00:00
|
|
|
# Lists the existing snapshots. Snapshots are used in [Seek]( https://cloud.
|
|
|
|
|
# google.com/pubsub/docs/replay-overview) operations, which allow you to manage
|
|
|
|
|
# message acknowledgments in bulk. That is, you can set the acknowledgment state
|
|
|
|
|
# of messages in an existing subscription to the state captured by a snapshot.
|
2017-12-02 00:36:26 +00:00
|
|
|
# @param [String] project
|
2020-08-14 00:38:12 +00:00
|
|
|
# Required. The name of the project in which to list snapshots. Format is `
|
|
|
|
|
# projects/`project-id``.
|
2017-12-02 00:36:26 +00:00
|
|
|
# @param [Fixnum] page_size
|
|
|
|
|
# Maximum number of snapshots to return.
|
|
|
|
|
# @param [String] page_token
|
2020-08-14 00:38:12 +00:00
|
|
|
# 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.
|
2017-12-02 00:36:26 +00:00
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::ListSnapshotsResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::PubsubV1::ListSnapshotsResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def list_project_snapshots(project, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:get, 'v1/{+project}/snapshots', options)
|
2017-12-02 00:36:26 +00:00
|
|
|
command.response_representation = Google::Apis::PubsubV1::ListSnapshotsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::ListSnapshotsResponse
|
|
|
|
|
command.params['project'] = project unless project.nil?
|
|
|
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
|
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2020-08-14 00:38:12 +00:00
|
|
|
# Updates an existing snapshot. Snapshots are used in Seek operations, which
|
|
|
|
|
# allow you to manage message acknowledgments in bulk. That is, you can set the
|
2018-09-05 00:36:34 +00:00
|
|
|
# acknowledgment state of messages in an existing subscription to the state
|
2019-03-14 00:37:43 +00:00
|
|
|
# captured by a snapshot.
|
2017-12-02 00:36:26 +00:00
|
|
|
# @param [String] name
|
|
|
|
|
# The name of the snapshot.
|
|
|
|
|
# @param [Google::Apis::PubsubV1::UpdateSnapshotRequest] update_snapshot_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::Snapshot] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::PubsubV1::Snapshot]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def patch_project_snapshot(name, update_snapshot_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:patch, 'v1/{+name}', options)
|
2017-12-02 00:36:26 +00:00
|
|
|
command.request_representation = Google::Apis::PubsubV1::UpdateSnapshotRequest::Representation
|
|
|
|
|
command.request_object = update_snapshot_request_object
|
|
|
|
|
command.response_representation = Google::Apis::PubsubV1::Snapshot::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::Snapshot
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2017-07-12 20:10:42 +00:00
|
|
|
# Sets the access control policy on the specified resource. Replaces any
|
2020-08-14 00:38:12 +00:00
|
|
|
# existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
|
|
|
|
|
# PERMISSION_DENIED` errors.
|
2017-07-12 20:10:42 +00:00
|
|
|
# @param [String] resource
|
2020-08-14 00:38:12 +00:00
|
|
|
# REQUIRED: The resource for which the policy is being specified. See the
|
|
|
|
|
# operation documentation for the appropriate value for this field.
|
2017-07-12 20:10:42 +00:00
|
|
|
# @param [Google::Apis::PubsubV1::SetIamPolicyRequest] set_iam_policy_request_object
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
2017-07-12 20:10:42 +00:00
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::Policy] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::PubsubV1::Policy]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2017-08-25 19:54:22 +00:00
|
|
|
def set_snapshot_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
|
2017-07-12 20:10:42 +00:00
|
|
|
command.request_representation = Google::Apis::PubsubV1::SetIamPolicyRequest::Representation
|
|
|
|
|
command.request_object = set_iam_policy_request_object
|
|
|
|
|
command.response_representation = Google::Apis::PubsubV1::Policy::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::Policy
|
|
|
|
|
command.params['resource'] = resource unless resource.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
2017-08-25 19:54:22 +00:00
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2017-07-12 20:10:42 +00:00
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2020-08-14 00:38:12 +00:00
|
|
|
# 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.
|
2017-06-14 17:02:03 +00:00
|
|
|
# @param [String] resource
|
2020-08-14 00:38:12 +00:00
|
|
|
# REQUIRED: The resource for which the policy detail is being requested. See the
|
|
|
|
|
# operation documentation for the appropriate value for this field.
|
2017-06-14 17:02:03 +00:00
|
|
|
# @param [Google::Apis::PubsubV1::TestIamPermissionsRequest] test_iam_permissions_request_object
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
2017-06-02 06:11:31 +00:00
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2017-06-14 17:02:03 +00:00
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::TestIamPermissionsResponse] parsed result object
|
2017-06-02 06:11:31 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
2017-06-14 17:02:03 +00:00
|
|
|
# @return [Google::Apis::PubsubV1::TestIamPermissionsResponse]
|
2017-06-02 06:11:31 +00:00
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2017-08-25 19:54:22 +00:00
|
|
|
def test_snapshot_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
|
2017-06-14 17:02:03 +00:00
|
|
|
command.request_representation = Google::Apis::PubsubV1::TestIamPermissionsRequest::Representation
|
|
|
|
|
command.request_object = test_iam_permissions_request_object
|
|
|
|
|
command.response_representation = Google::Apis::PubsubV1::TestIamPermissionsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::TestIamPermissionsResponse
|
|
|
|
|
command.params['resource'] = resource unless resource.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
2017-08-25 19:54:22 +00:00
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2017-06-02 06:11:31 +00:00
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2020-08-14 00:38:12 +00:00
|
|
|
# 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.
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [String] subscription
|
2020-08-14 00:38:12 +00:00
|
|
|
# Required. The subscription whose message is being acknowledged. Format is `
|
|
|
|
|
# projects/`project`/subscriptions/`sub``.
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [Google::Apis::PubsubV1::AcknowledgeRequest] acknowledge_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
2017-06-02 06:11:31 +00:00
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2017-08-25 19:54:22 +00:00
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::Empty] parsed result object
|
2017-06-02 06:11:31 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
2017-08-25 19:54:22 +00:00
|
|
|
# @return [Google::Apis::PubsubV1::Empty]
|
2017-06-02 06:11:31 +00:00
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2017-08-25 19:54:22 +00:00
|
|
|
def acknowledge_subscription(subscription, acknowledge_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:post, 'v1/{+subscription}:acknowledge', options)
|
2017-08-25 19:54:22 +00:00
|
|
|
command.request_representation = Google::Apis::PubsubV1::AcknowledgeRequest::Representation
|
|
|
|
|
command.request_object = acknowledge_request_object
|
|
|
|
|
command.response_representation = Google::Apis::PubsubV1::Empty::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::Empty
|
|
|
|
|
command.params['subscription'] = subscription unless subscription.nil?
|
2017-06-14 17:02:03 +00:00
|
|
|
command.query['fields'] = fields unless fields.nil?
|
2017-08-25 19:54:22 +00:00
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2017-06-02 06:11:31 +00:00
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2020-08-14 00:38:12 +00:00
|
|
|
# Creates a subscription to a given topic. See the [resource name rules] (https:/
|
|
|
|
|
# /cloud.google.com/pubsub/docs/admin#resource_names). If the subscription
|
|
|
|
|
# already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't
|
|
|
|
|
# exist, returns `NOT_FOUND`. If the name is not provided in the request, the
|
|
|
|
|
# server will assign a random name for this subscription on the same project as
|
|
|
|
|
# the topic, conforming to the [resource name format] (https://cloud.google.com/
|
|
|
|
|
# pubsub/docs/admin#resource_names). The generated name is populated in the
|
|
|
|
|
# returned Subscription object. Note that for REST API requests, you must
|
|
|
|
|
# specify a name in the request.
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [String] name
|
2020-08-14 00:38:12 +00:00
|
|
|
# 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"`.
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [Google::Apis::PubsubV1::Subscription] subscription_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
2017-06-02 06:11:31 +00:00
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2017-08-25 19:54:22 +00:00
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::Subscription] parsed result object
|
2017-06-02 06:11:31 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
2017-08-25 19:54:22 +00:00
|
|
|
# @return [Google::Apis::PubsubV1::Subscription]
|
2017-06-02 06:11:31 +00:00
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2017-08-25 19:54:22 +00:00
|
|
|
def create_subscription(name, subscription_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:put, 'v1/{+name}', options)
|
2017-08-25 19:54:22 +00:00
|
|
|
command.request_representation = Google::Apis::PubsubV1::Subscription::Representation
|
|
|
|
|
command.request_object = subscription_object
|
|
|
|
|
command.response_representation = Google::Apis::PubsubV1::Subscription::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::Subscription
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
2017-06-14 17:02:03 +00:00
|
|
|
command.query['fields'] = fields unless fields.nil?
|
2017-08-25 19:54:22 +00:00
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2017-06-02 06:11:31 +00:00
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2017-08-25 19:54:22 +00:00
|
|
|
# Deletes an existing subscription. All messages retained in the subscription
|
2020-08-14 00:38:12 +00:00
|
|
|
# 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.
|
2017-06-14 17:02:03 +00:00
|
|
|
# @param [String] subscription
|
2020-08-14 00:38:12 +00:00
|
|
|
# Required. The subscription to delete. Format is `projects/`project`/
|
|
|
|
|
# subscriptions/`sub``.
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
2017-05-26 16:44:32 +00:00
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2017-08-25 19:54:22 +00:00
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::Empty] parsed result object
|
2017-05-26 16:44:32 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
2017-08-25 19:54:22 +00:00
|
|
|
# @return [Google::Apis::PubsubV1::Empty]
|
2017-05-26 16:44:32 +00:00
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2017-08-25 19:54:22 +00:00
|
|
|
def delete_subscription(subscription, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:delete, 'v1/{+subscription}', options)
|
2017-08-25 19:54:22 +00:00
|
|
|
command.response_representation = Google::Apis::PubsubV1::Empty::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::Empty
|
2017-06-14 17:02:03 +00:00
|
|
|
command.params['subscription'] = subscription unless subscription.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
2017-08-25 19:54:22 +00:00
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2017-05-26 16:44:32 +00:00
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2020-06-05 00:39:06 +00:00
|
|
|
# Detaches a subscription from this topic. All messages retained in the
|
2020-08-14 00:38:12 +00:00
|
|
|
# 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.
|
2020-06-05 00:39:06 +00:00
|
|
|
# @param [String] subscription
|
2020-08-14 00:38:12 +00:00
|
|
|
# Required. The subscription to detach. Format is `projects/`project`/
|
|
|
|
|
# subscriptions/`subscription``.
|
2020-06-05 00:39:06 +00:00
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::DetachSubscriptionResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::PubsubV1::DetachSubscriptionResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def detach_project_subscription(subscription, fields: nil, quota_user: nil, options: nil, &block)
|
|
|
|
|
command = make_simple_command(:post, 'v1/{+subscription}:detach', options)
|
|
|
|
|
command.response_representation = Google::Apis::PubsubV1::DetachSubscriptionResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::DetachSubscriptionResponse
|
|
|
|
|
command.params['subscription'] = subscription unless subscription.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2017-08-25 19:54:22 +00:00
|
|
|
# Gets the configuration details of a subscription.
|
|
|
|
|
# @param [String] subscription
|
2020-08-14 00:38:12 +00:00
|
|
|
# Required. The name of the subscription to get. Format is `projects/`project`/
|
|
|
|
|
# subscriptions/`sub``.
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
2017-05-26 16:44:32 +00:00
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2017-08-25 19:54:22 +00:00
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::Subscription] parsed result object
|
2017-05-26 16:44:32 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
2017-08-25 19:54:22 +00:00
|
|
|
# @return [Google::Apis::PubsubV1::Subscription]
|
2017-05-26 16:44:32 +00:00
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2017-08-25 19:54:22 +00:00
|
|
|
def get_subscription(subscription, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:get, 'v1/{+subscription}', options)
|
2017-08-25 19:54:22 +00:00
|
|
|
command.response_representation = Google::Apis::PubsubV1::Subscription::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::Subscription
|
|
|
|
|
command.params['subscription'] = subscription unless subscription.nil?
|
2017-06-14 17:02:03 +00:00
|
|
|
command.query['fields'] = fields unless fields.nil?
|
2017-08-25 19:54:22 +00:00
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2017-05-26 16:44:32 +00:00
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2020-08-14 00:38:12 +00:00
|
|
|
# Gets the access control policy for a resource. Returns an empty policy if the
|
|
|
|
|
# resource exists and does not have a policy set.
|
2017-05-04 19:35:56 +00:00
|
|
|
# @param [String] resource
|
2020-08-14 00:38:12 +00:00
|
|
|
# REQUIRED: The resource for which the policy is being requested. See the
|
|
|
|
|
# operation documentation for the appropriate value for this field.
|
2019-07-12 00:38:14 +00:00
|
|
|
# @param [Fixnum] options_requested_policy_version
|
2020-08-14 00:38:12 +00:00
|
|
|
# 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](https://cloud.google.com/iam/help/conditions/
|
|
|
|
|
# resource-policies).
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
2017-05-04 19:35:56 +00:00
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2017-06-14 17:02:03 +00:00
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::Policy] parsed result object
|
2017-05-04 19:35:56 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
2017-06-14 17:02:03 +00:00
|
|
|
# @return [Google::Apis::PubsubV1::Policy]
|
2017-05-04 19:35:56 +00:00
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2019-07-12 00:38:14 +00:00
|
|
|
def get_project_subscription_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
|
2017-06-14 17:02:03 +00:00
|
|
|
command.response_representation = Google::Apis::PubsubV1::Policy::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::Policy
|
2017-05-04 19:35:56 +00:00
|
|
|
command.params['resource'] = resource unless resource.nil?
|
2019-07-12 00:38:14 +00:00
|
|
|
command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
|
2017-06-14 17:02:03 +00:00
|
|
|
command.query['fields'] = fields unless fields.nil?
|
2017-08-25 19:54:22 +00:00
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2017-05-04 19:35:56 +00:00
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2017-08-25 19:54:22 +00:00
|
|
|
# Lists matching subscriptions.
|
|
|
|
|
# @param [String] project
|
2020-08-14 00:38:12 +00:00
|
|
|
# Required. The name of the project in which to list subscriptions. Format is `
|
|
|
|
|
# projects/`project-id``.
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [Fixnum] page_size
|
|
|
|
|
# Maximum number of subscriptions to return.
|
|
|
|
|
# @param [String] page_token
|
|
|
|
|
# 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.
|
2017-03-31 19:53:27 +00:00
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
2017-03-27 22:14:47 +00:00
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2017-08-25 19:54:22 +00:00
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::ListSubscriptionsResponse] parsed result object
|
2017-03-27 22:14:47 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
2017-08-25 19:54:22 +00:00
|
|
|
# @return [Google::Apis::PubsubV1::ListSubscriptionsResponse]
|
2017-03-27 22:14:47 +00:00
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2017-08-25 19:54:22 +00:00
|
|
|
def list_subscriptions(project, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:get, 'v1/{+project}/subscriptions', options)
|
2017-08-25 19:54:22 +00:00
|
|
|
command.response_representation = Google::Apis::PubsubV1::ListSubscriptionsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::ListSubscriptionsResponse
|
|
|
|
|
command.params['project'] = project unless project.nil?
|
|
|
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
|
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
2017-06-14 17:02:03 +00:00
|
|
|
command.query['fields'] = fields unless fields.nil?
|
2017-08-25 19:54:22 +00:00
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2017-03-27 22:14:47 +00:00
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2020-08-14 00:38:12 +00:00
|
|
|
# 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.
|
2017-06-14 17:02:03 +00:00
|
|
|
# @param [String] subscription
|
2020-08-14 00:38:12 +00:00
|
|
|
# Required. The name of the subscription. Format is `projects/`project`/
|
|
|
|
|
# subscriptions/`sub``.
|
2017-06-14 17:02:03 +00:00
|
|
|
# @param [Google::Apis::PubsubV1::ModifyAckDeadlineRequest] modify_ack_deadline_request_object
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
2017-02-03 19:29:28 +00:00
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
2017-02-13 23:28:52 +00:00
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2017-06-14 17:02:03 +00:00
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::Empty] parsed result object
|
2017-02-13 23:28:52 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
2017-06-14 17:02:03 +00:00
|
|
|
# @return [Google::Apis::PubsubV1::Empty]
|
2017-02-13 23:28:52 +00:00
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2017-08-25 19:54:22 +00:00
|
|
|
def modify_subscription_ack_deadline(subscription, modify_ack_deadline_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:post, 'v1/{+subscription}:modifyAckDeadline', options)
|
2017-06-14 17:02:03 +00:00
|
|
|
command.request_representation = Google::Apis::PubsubV1::ModifyAckDeadlineRequest::Representation
|
|
|
|
|
command.request_object = modify_ack_deadline_request_object
|
|
|
|
|
command.response_representation = Google::Apis::PubsubV1::Empty::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::Empty
|
|
|
|
|
command.params['subscription'] = subscription unless subscription.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
2017-08-25 19:54:22 +00:00
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2017-02-13 23:28:52 +00:00
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2020-08-14 00:38:12 +00:00
|
|
|
# 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`.
|
2017-07-12 20:10:42 +00:00
|
|
|
# @param [String] subscription
|
2020-08-14 00:38:12 +00:00
|
|
|
# Required. The name of the subscription. Format is `projects/`project`/
|
|
|
|
|
# subscriptions/`sub``.
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [Google::Apis::PubsubV1::ModifyPushConfigRequest] modify_push_config_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
2017-02-03 19:29:28 +00:00
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2017-07-12 20:10:42 +00:00
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::Empty] parsed result object
|
2017-02-03 19:29:28 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
2017-07-12 20:10:42 +00:00
|
|
|
# @return [Google::Apis::PubsubV1::Empty]
|
2017-02-03 19:29:28 +00:00
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2017-08-25 19:54:22 +00:00
|
|
|
def modify_subscription_push_config(subscription, modify_push_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:post, 'v1/{+subscription}:modifyPushConfig', options)
|
2017-08-25 19:54:22 +00:00
|
|
|
command.request_representation = Google::Apis::PubsubV1::ModifyPushConfigRequest::Representation
|
|
|
|
|
command.request_object = modify_push_config_request_object
|
2017-07-12 20:10:42 +00:00
|
|
|
command.response_representation = Google::Apis::PubsubV1::Empty::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::Empty
|
|
|
|
|
command.params['subscription'] = subscription unless subscription.nil?
|
2017-06-14 17:02:03 +00:00
|
|
|
command.query['fields'] = fields unless fields.nil?
|
2017-08-25 19:54:22 +00:00
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2017-02-03 19:29:28 +00:00
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2017-12-02 00:36:26 +00:00
|
|
|
# Updates an existing subscription. Note that certain properties of a
|
|
|
|
|
# subscription, such as its topic, are not modifiable.
|
|
|
|
|
# @param [String] name
|
2020-08-14 00:38:12 +00:00
|
|
|
# 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"`.
|
2017-12-02 00:36:26 +00:00
|
|
|
# @param [Google::Apis::PubsubV1::UpdateSubscriptionRequest] update_subscription_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::Subscription] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::PubsubV1::Subscription]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def patch_project_subscription(name, update_subscription_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:patch, 'v1/{+name}', options)
|
2017-12-02 00:36:26 +00:00
|
|
|
command.request_representation = Google::Apis::PubsubV1::UpdateSubscriptionRequest::Representation
|
|
|
|
|
command.request_object = update_subscription_request_object
|
|
|
|
|
command.response_representation = Google::Apis::PubsubV1::Subscription::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::Subscription
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2020-08-14 00:38:12 +00:00
|
|
|
# Pulls messages from the server. The server may return `UNAVAILABLE` if there
|
|
|
|
|
# are too many concurrent pull requests pending for the given subscription.
|
2017-06-02 06:11:31 +00:00
|
|
|
# @param [String] subscription
|
2020-08-14 00:38:12 +00:00
|
|
|
# Required. The subscription from which messages should be pulled. Format is `
|
|
|
|
|
# projects/`project`/subscriptions/`sub``.
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [Google::Apis::PubsubV1::PullRequest] pull_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
2017-02-03 19:29:28 +00:00
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2017-08-25 19:54:22 +00:00
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::PullResponse] parsed result object
|
2017-02-03 19:29:28 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
2017-08-25 19:54:22 +00:00
|
|
|
# @return [Google::Apis::PubsubV1::PullResponse]
|
2017-02-03 19:29:28 +00:00
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2017-08-25 19:54:22 +00:00
|
|
|
def pull_subscription(subscription, pull_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:post, 'v1/{+subscription}:pull', options)
|
2017-08-25 19:54:22 +00:00
|
|
|
command.request_representation = Google::Apis::PubsubV1::PullRequest::Representation
|
|
|
|
|
command.request_object = pull_request_object
|
|
|
|
|
command.response_representation = Google::Apis::PubsubV1::PullResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::PullResponse
|
2017-06-02 06:11:31 +00:00
|
|
|
command.params['subscription'] = subscription unless subscription.nil?
|
2017-06-14 17:02:03 +00:00
|
|
|
command.query['fields'] = fields unless fields.nil?
|
2017-08-25 19:54:22 +00:00
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2017-02-03 19:29:28 +00:00
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2017-12-02 00:36:26 +00:00
|
|
|
# Seeks an existing subscription to a point in time or to a given snapshot,
|
feat: Automated regeneration of pubsub v1 client (#1267)
This PR was generated using Autosynth. :rainbow:
<details><summary>Log from Synthtool</summary>
```
2020-10-23 03:01:43,860 synthtool [DEBUG] > Executing /home/kbuilder/.cache/synthtool/google-api-ruby-client/synth.py.
On branch autosynth-pubsub-v1
nothing to commit, working tree clean
2020-10-23 03:01:43,894 synthtool [DEBUG] > Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth pubsub v1
DEBUG:synthtool:Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth pubsub v1
bundle install
Don't run Bundler as root. Bundler can ask for sudo if it is needed, and
installing your bundle as root will break this application for all non-root
users on this machine.
The dependency jruby-openssl (>= 0) will be unused by any of the platforms Bundler is installing for. Bundler is installing for ruby but the dependency is only for java. To add those platforms to the bundle, run `bundle lock --add-platform java`.
Fetching gem metadata from https://rubygems.org/.........
Fetching gem metadata from https://rubygems.org/.
Resolving dependencies...
Fetching rake 11.3.0
Installing rake 11.3.0
Fetching concurrent-ruby 1.1.7
Installing concurrent-ruby 1.1.7
Fetching i18n 1.8.5
Installing i18n 1.8.5
Fetching minitest 5.14.2
Installing minitest 5.14.2
Fetching thread_safe 0.3.6
Installing thread_safe 0.3.6
Fetching tzinfo 1.2.7
Installing tzinfo 1.2.7
Fetching activesupport 5.0.7.2
Installing activesupport 5.0.7.2
Fetching public_suffix 4.0.6
Installing public_suffix 4.0.6
Fetching addressable 2.7.0
Installing addressable 2.7.0
Fetching ast 2.4.1
Installing ast 2.4.1
Using bundler 2.1.4
Fetching byebug 11.1.3
Installing byebug 11.1.3 with native extensions
Fetching coderay 1.1.3
Installing coderay 1.1.3
Fetching json 2.3.1
Installing json 2.3.1 with native extensions
Fetching docile 1.3.2
Installing docile 1.3.2
Fetching simplecov-html 0.10.2
Installing simplecov-html 0.10.2
Fetching simplecov 0.16.1
Installing simplecov 0.16.1
Using sync 0.5.0
Fetching tins 1.26.0
Installing tins 1.26.0
Fetching term-ansicolor 1.7.1
Installing term-ansicolor 1.7.1
Fetching thor 0.20.3
Installing thor 0.20.3
Fetching coveralls 0.8.23
Installing coveralls 0.8.23
Fetching crack 0.4.4
Installing crack 0.4.4
Fetching declarative 0.0.20
Installing declarative 0.0.20
Fetching declarative-option 0.1.0
Installing declarative-option 0.1.0
Fetching diff-lcs 1.4.4
Installing diff-lcs 1.4.4
Fetching dotenv 2.7.6
Installing dotenv 2.7.6
Fetching fakefs 0.20.1
Installing fakefs 0.20.1
Fetching multipart-post 2.1.1
Installing multipart-post 2.1.1
Fetching ruby2_keywords 0.0.2
Installing ruby2_keywords 0.0.2
Fetching faraday 1.1.0
Installing faraday 1.1.0
Fetching github-markup 1.7.0
Installing github-markup 1.7.0
Fetching jwt 2.2.2
Installing jwt 2.2.2
Fetching memoist 0.16.2
Installing memoist 0.16.2
Fetching multi_json 1.15.0
Installing multi_json 1.15.0
Fetching os 0.9.6
Installing os 0.9.6
Fetching signet 0.14.0
Installing signet 0.14.0
Fetching googleauth 0.14.0
Installing googleauth 0.14.0
Fetching httpclient 2.8.3
Installing httpclient 2.8.3
Fetching mini_mime 1.0.2
Installing mini_mime 1.0.2
Fetching uber 0.1.0
Installing uber 0.1.0
Fetching representable 3.0.4
Installing representable 3.0.4
Fetching retriable 3.1.2
Installing retriable 3.1.2
Fetching rexml 3.2.4
Installing rexml 3.2.4
Using google-api-client 0.46.2 from source at `.`
Fetching google-id-token 1.4.2
Installing google-id-token 1.4.2
Fetching hashdiff 1.0.1
Installing hashdiff 1.0.1
Fetching mime-types-data 3.2020.0512
Installing mime-types-data 3.2020.0512
Fetching mime-types 3.3.1
Installing mime-types 3.3.1
Fetching multi_xml 0.6.0
Installing multi_xml 0.6.0
Fetching httparty 0.18.1
Installing httparty 0.18.1
Fetching rspec-support 3.9.3
Installing rspec-support 3.9.3
Fetching rspec-core 3.9.3
Installing rspec-core 3.9.3
Fetching rspec-expectations 3.9.2
Installing rspec-expectations 3.9.2
Fetching rspec-mocks 3.9.1
Installing rspec-mocks 3.9.1
Fetching rspec 3.9.0
Installing rspec 3.9.0
Fetching json_spec 1.1.5
Installing json_spec 1.1.5
Fetching launchy 2.5.0
Installing launchy 2.5.0
Fetching little-plugger 1.1.4
Installing little-plugger 1.1.4
Fetching logging 2.3.0
Installing logging 2.3.0
Fetching method_source 1.0.0
Installing method_source 1.0.0
Fetching opencensus 0.5.0
Installing opencensus 0.5.0
Fetching parallel 1.19.2
Installing parallel 1.19.2
Fetching parser 2.7.2.0
Installing parser 2.7.2.0
Fetching powerpack 0.1.2
Installing powerpack 0.1.2
Fetching pry 0.13.1
Installing pry 0.13.1
Fetching pry-byebug 3.9.0
Installing pry-byebug 3.9.0
Fetching yard 0.9.25
Installing yard 0.9.25
Fetching pry-doc 0.13.5
Installing pry-doc 0.13.5
Fetching rainbow 2.2.2
Installing rainbow 2.2.2 with native extensions
Fetching redcarpet 3.5.0
Installing redcarpet 3.5.0 with native extensions
Fetching redis 3.3.5
Installing redis 3.3.5
Fetching rmail 1.1.4
Installing rmail 1.1.4
Fetching ruby-progressbar 1.10.1
Installing ruby-progressbar 1.10.1
Fetching unicode-display_width 1.7.0
Installing unicode-display_width 1.7.0
Fetching rubocop 0.49.1
Installing rubocop 0.49.1
Fetching webmock 2.3.2
Installing webmock 2.3.2
Bundle complete! 30 Gemfile dependencies, 77 gems now installed.
Use `bundle info [gemname]` to see where a bundled gem is installed.
Post-install message from i18n:
HEADS UP! i18n 1.1 changed fallbacks to exclude default locale.
But that may break your application.
If you are upgrading your Rails application from an older version of Rails:
Please check your Rails app for 'config.i18n.fallbacks = true'.
If you're using I18n (>= 1.1.0) and Rails (< 5.2.2), this should be
'config.i18n.fallbacks = [I18n.default_locale]'.
If not, fallbacks will be broken in your app by I18n 1.1.x.
If you are starting a NEW Rails application, you can ignore this notice.
For more info see:
https://github.com/svenfuchs/i18n/releases/tag/v1.1.0
Post-install message from httparty:
When you HTTParty, you must party hard!
echo a | bundle exec bin/generate-api gen generated --api=pubsub.v1 --names-out=/workspace/api_names_out.yaml
Loading pubsub, version v1 from https://raw.githubusercontent.com/googleapis/discovery-artifact-manager/master/discoveries/pubsub.v1.json
conflict google/apis/pubsub_v1.rb
</apis/pubsub_v1.rb? (enter "h" for help) [Ynaqdhm] a
force google/apis/pubsub_v1.rb
conflict google/apis/pubsub_v1/service.rb
force google/apis/pubsub_v1/service.rb
identical google/apis/pubsub_v1/classes.rb
identical google/apis/pubsub_v1/representations.rb
identical /workspace/api_names_out.yaml
2020-10-23 03:02:10,970 synthtool [DEBUG] > Wrote metadata to generated/google/apis/pubsub_v1/synth.metadata.
DEBUG:synthtool:Wrote metadata to generated/google/apis/pubsub_v1/synth.metadata.
```
</details>
Full log will be available here:
https://source.cloud.google.com/results/invocations/b5264f4d-f9b1-43ca-9f8e-daf952acfa30/targets
- [ ] To automatically regenerate this PR, check this box.
2020-10-23 14:02:03 +00:00
|
|
|
# whichever is provided in the request. Snapshots are used in [Seek] (https://
|
2020-08-14 00:38:12 +00:00
|
|
|
# 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.
|
2017-12-02 00:36:26 +00:00
|
|
|
# @param [String] subscription
|
2020-02-29 00:38:29 +00:00
|
|
|
# Required. The subscription to affect.
|
2017-12-02 00:36:26 +00:00
|
|
|
# @param [Google::Apis::PubsubV1::SeekRequest] seek_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::SeekResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::PubsubV1::SeekResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def seek_subscription(subscription, seek_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:post, 'v1/{+subscription}:seek', options)
|
2017-12-02 00:36:26 +00:00
|
|
|
command.request_representation = Google::Apis::PubsubV1::SeekRequest::Representation
|
|
|
|
|
command.request_object = seek_request_object
|
|
|
|
|
command.response_representation = Google::Apis::PubsubV1::SeekResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::SeekResponse
|
|
|
|
|
command.params['subscription'] = subscription unless subscription.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2017-08-25 19:54:22 +00:00
|
|
|
# Sets the access control policy on the specified resource. Replaces any
|
2020-08-14 00:38:12 +00:00
|
|
|
# existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
|
|
|
|
|
# PERMISSION_DENIED` errors.
|
2017-05-26 16:44:32 +00:00
|
|
|
# @param [String] resource
|
2020-08-14 00:38:12 +00:00
|
|
|
# REQUIRED: The resource for which the policy is being specified. See the
|
|
|
|
|
# operation documentation for the appropriate value for this field.
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [Google::Apis::PubsubV1::SetIamPolicyRequest] set_iam_policy_request_object
|
2017-06-14 17:02:03 +00:00
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
2017-02-03 19:29:28 +00:00
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
2017-03-27 22:14:47 +00:00
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2017-08-25 19:54:22 +00:00
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::Policy] parsed result object
|
2017-03-27 22:14:47 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
2017-08-25 19:54:22 +00:00
|
|
|
# @return [Google::Apis::PubsubV1::Policy]
|
2017-03-27 22:14:47 +00:00
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2017-08-25 19:54:22 +00:00
|
|
|
def set_subscription_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
|
2017-08-25 19:54:22 +00:00
|
|
|
command.request_representation = Google::Apis::PubsubV1::SetIamPolicyRequest::Representation
|
|
|
|
|
command.request_object = set_iam_policy_request_object
|
|
|
|
|
command.response_representation = Google::Apis::PubsubV1::Policy::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::Policy
|
|
|
|
|
command.params['resource'] = resource unless resource.nil?
|
2017-07-12 20:10:42 +00:00
|
|
|
command.query['fields'] = fields unless fields.nil?
|
2017-08-25 19:54:22 +00:00
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2017-07-12 20:10:42 +00:00
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2020-08-14 00:38:12 +00:00
|
|
|
# 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.
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [String] resource
|
2020-08-14 00:38:12 +00:00
|
|
|
# REQUIRED: The resource for which the policy detail is being requested. See the
|
|
|
|
|
# operation documentation for the appropriate value for this field.
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [Google::Apis::PubsubV1::TestIamPermissionsRequest] test_iam_permissions_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
2017-07-12 20:10:42 +00:00
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2017-08-25 19:54:22 +00:00
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::TestIamPermissionsResponse] parsed result object
|
2017-07-12 20:10:42 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
2017-08-25 19:54:22 +00:00
|
|
|
# @return [Google::Apis::PubsubV1::TestIamPermissionsResponse]
|
2017-07-12 20:10:42 +00:00
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2017-08-25 19:54:22 +00:00
|
|
|
def test_subscription_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
|
2017-08-25 19:54:22 +00:00
|
|
|
command.request_representation = Google::Apis::PubsubV1::TestIamPermissionsRequest::Representation
|
|
|
|
|
command.request_object = test_iam_permissions_request_object
|
|
|
|
|
command.response_representation = Google::Apis::PubsubV1::TestIamPermissionsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::TestIamPermissionsResponse
|
|
|
|
|
command.params['resource'] = resource unless resource.nil?
|
2017-07-12 20:10:42 +00:00
|
|
|
command.query['fields'] = fields unless fields.nil?
|
2017-08-25 19:54:22 +00:00
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2017-07-12 20:10:42 +00:00
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
feat: Automated regeneration of pubsub v1 client (#1267)
This PR was generated using Autosynth. :rainbow:
<details><summary>Log from Synthtool</summary>
```
2020-10-23 03:01:43,860 synthtool [DEBUG] > Executing /home/kbuilder/.cache/synthtool/google-api-ruby-client/synth.py.
On branch autosynth-pubsub-v1
nothing to commit, working tree clean
2020-10-23 03:01:43,894 synthtool [DEBUG] > Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth pubsub v1
DEBUG:synthtool:Running: docker run --rm -v/home/kbuilder/.cache/synthtool/google-api-ruby-client:/workspace -v/var/run/docker.sock:/var/run/docker.sock -w /workspace --entrypoint script/synth.rb gcr.io/cloud-devrel-kokoro-resources/yoshi-ruby/autosynth pubsub v1
bundle install
Don't run Bundler as root. Bundler can ask for sudo if it is needed, and
installing your bundle as root will break this application for all non-root
users on this machine.
The dependency jruby-openssl (>= 0) will be unused by any of the platforms Bundler is installing for. Bundler is installing for ruby but the dependency is only for java. To add those platforms to the bundle, run `bundle lock --add-platform java`.
Fetching gem metadata from https://rubygems.org/.........
Fetching gem metadata from https://rubygems.org/.
Resolving dependencies...
Fetching rake 11.3.0
Installing rake 11.3.0
Fetching concurrent-ruby 1.1.7
Installing concurrent-ruby 1.1.7
Fetching i18n 1.8.5
Installing i18n 1.8.5
Fetching minitest 5.14.2
Installing minitest 5.14.2
Fetching thread_safe 0.3.6
Installing thread_safe 0.3.6
Fetching tzinfo 1.2.7
Installing tzinfo 1.2.7
Fetching activesupport 5.0.7.2
Installing activesupport 5.0.7.2
Fetching public_suffix 4.0.6
Installing public_suffix 4.0.6
Fetching addressable 2.7.0
Installing addressable 2.7.0
Fetching ast 2.4.1
Installing ast 2.4.1
Using bundler 2.1.4
Fetching byebug 11.1.3
Installing byebug 11.1.3 with native extensions
Fetching coderay 1.1.3
Installing coderay 1.1.3
Fetching json 2.3.1
Installing json 2.3.1 with native extensions
Fetching docile 1.3.2
Installing docile 1.3.2
Fetching simplecov-html 0.10.2
Installing simplecov-html 0.10.2
Fetching simplecov 0.16.1
Installing simplecov 0.16.1
Using sync 0.5.0
Fetching tins 1.26.0
Installing tins 1.26.0
Fetching term-ansicolor 1.7.1
Installing term-ansicolor 1.7.1
Fetching thor 0.20.3
Installing thor 0.20.3
Fetching coveralls 0.8.23
Installing coveralls 0.8.23
Fetching crack 0.4.4
Installing crack 0.4.4
Fetching declarative 0.0.20
Installing declarative 0.0.20
Fetching declarative-option 0.1.0
Installing declarative-option 0.1.0
Fetching diff-lcs 1.4.4
Installing diff-lcs 1.4.4
Fetching dotenv 2.7.6
Installing dotenv 2.7.6
Fetching fakefs 0.20.1
Installing fakefs 0.20.1
Fetching multipart-post 2.1.1
Installing multipart-post 2.1.1
Fetching ruby2_keywords 0.0.2
Installing ruby2_keywords 0.0.2
Fetching faraday 1.1.0
Installing faraday 1.1.0
Fetching github-markup 1.7.0
Installing github-markup 1.7.0
Fetching jwt 2.2.2
Installing jwt 2.2.2
Fetching memoist 0.16.2
Installing memoist 0.16.2
Fetching multi_json 1.15.0
Installing multi_json 1.15.0
Fetching os 0.9.6
Installing os 0.9.6
Fetching signet 0.14.0
Installing signet 0.14.0
Fetching googleauth 0.14.0
Installing googleauth 0.14.0
Fetching httpclient 2.8.3
Installing httpclient 2.8.3
Fetching mini_mime 1.0.2
Installing mini_mime 1.0.2
Fetching uber 0.1.0
Installing uber 0.1.0
Fetching representable 3.0.4
Installing representable 3.0.4
Fetching retriable 3.1.2
Installing retriable 3.1.2
Fetching rexml 3.2.4
Installing rexml 3.2.4
Using google-api-client 0.46.2 from source at `.`
Fetching google-id-token 1.4.2
Installing google-id-token 1.4.2
Fetching hashdiff 1.0.1
Installing hashdiff 1.0.1
Fetching mime-types-data 3.2020.0512
Installing mime-types-data 3.2020.0512
Fetching mime-types 3.3.1
Installing mime-types 3.3.1
Fetching multi_xml 0.6.0
Installing multi_xml 0.6.0
Fetching httparty 0.18.1
Installing httparty 0.18.1
Fetching rspec-support 3.9.3
Installing rspec-support 3.9.3
Fetching rspec-core 3.9.3
Installing rspec-core 3.9.3
Fetching rspec-expectations 3.9.2
Installing rspec-expectations 3.9.2
Fetching rspec-mocks 3.9.1
Installing rspec-mocks 3.9.1
Fetching rspec 3.9.0
Installing rspec 3.9.0
Fetching json_spec 1.1.5
Installing json_spec 1.1.5
Fetching launchy 2.5.0
Installing launchy 2.5.0
Fetching little-plugger 1.1.4
Installing little-plugger 1.1.4
Fetching logging 2.3.0
Installing logging 2.3.0
Fetching method_source 1.0.0
Installing method_source 1.0.0
Fetching opencensus 0.5.0
Installing opencensus 0.5.0
Fetching parallel 1.19.2
Installing parallel 1.19.2
Fetching parser 2.7.2.0
Installing parser 2.7.2.0
Fetching powerpack 0.1.2
Installing powerpack 0.1.2
Fetching pry 0.13.1
Installing pry 0.13.1
Fetching pry-byebug 3.9.0
Installing pry-byebug 3.9.0
Fetching yard 0.9.25
Installing yard 0.9.25
Fetching pry-doc 0.13.5
Installing pry-doc 0.13.5
Fetching rainbow 2.2.2
Installing rainbow 2.2.2 with native extensions
Fetching redcarpet 3.5.0
Installing redcarpet 3.5.0 with native extensions
Fetching redis 3.3.5
Installing redis 3.3.5
Fetching rmail 1.1.4
Installing rmail 1.1.4
Fetching ruby-progressbar 1.10.1
Installing ruby-progressbar 1.10.1
Fetching unicode-display_width 1.7.0
Installing unicode-display_width 1.7.0
Fetching rubocop 0.49.1
Installing rubocop 0.49.1
Fetching webmock 2.3.2
Installing webmock 2.3.2
Bundle complete! 30 Gemfile dependencies, 77 gems now installed.
Use `bundle info [gemname]` to see where a bundled gem is installed.
Post-install message from i18n:
HEADS UP! i18n 1.1 changed fallbacks to exclude default locale.
But that may break your application.
If you are upgrading your Rails application from an older version of Rails:
Please check your Rails app for 'config.i18n.fallbacks = true'.
If you're using I18n (>= 1.1.0) and Rails (< 5.2.2), this should be
'config.i18n.fallbacks = [I18n.default_locale]'.
If not, fallbacks will be broken in your app by I18n 1.1.x.
If you are starting a NEW Rails application, you can ignore this notice.
For more info see:
https://github.com/svenfuchs/i18n/releases/tag/v1.1.0
Post-install message from httparty:
When you HTTParty, you must party hard!
echo a | bundle exec bin/generate-api gen generated --api=pubsub.v1 --names-out=/workspace/api_names_out.yaml
Loading pubsub, version v1 from https://raw.githubusercontent.com/googleapis/discovery-artifact-manager/master/discoveries/pubsub.v1.json
conflict google/apis/pubsub_v1.rb
</apis/pubsub_v1.rb? (enter "h" for help) [Ynaqdhm] a
force google/apis/pubsub_v1.rb
conflict google/apis/pubsub_v1/service.rb
force google/apis/pubsub_v1/service.rb
identical google/apis/pubsub_v1/classes.rb
identical google/apis/pubsub_v1/representations.rb
identical /workspace/api_names_out.yaml
2020-10-23 03:02:10,970 synthtool [DEBUG] > Wrote metadata to generated/google/apis/pubsub_v1/synth.metadata.
DEBUG:synthtool:Wrote metadata to generated/google/apis/pubsub_v1/synth.metadata.
```
</details>
Full log will be available here:
https://source.cloud.google.com/results/invocations/b5264f4d-f9b1-43ca-9f8e-daf952acfa30/targets
- [ ] To automatically regenerate this PR, check this box.
2020-10-23 14:02:03 +00:00
|
|
|
# Creates the given topic with the given name. See the [resource name rules] (
|
2020-07-11 00:38:36 +00:00
|
|
|
# https://cloud.google.com/pubsub/docs/admin#resource_names).
|
2017-07-12 20:10:42 +00:00
|
|
|
# @param [String] name
|
2020-08-14 00:38:12 +00:00
|
|
|
# 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"`.
|
2017-07-12 20:10:42 +00:00
|
|
|
# @param [Google::Apis::PubsubV1::Topic] topic_object
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
2017-07-12 20:10:42 +00:00
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::Topic] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::PubsubV1::Topic]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2017-08-25 19:54:22 +00:00
|
|
|
def create_topic(name, topic_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:put, 'v1/{+name}', options)
|
2017-07-12 20:10:42 +00:00
|
|
|
command.request_representation = Google::Apis::PubsubV1::Topic::Representation
|
|
|
|
|
command.request_object = topic_object
|
|
|
|
|
command.response_representation = Google::Apis::PubsubV1::Topic::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::Topic
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
2017-06-14 17:02:03 +00:00
|
|
|
command.query['fields'] = fields unless fields.nil?
|
2017-08-25 19:54:22 +00:00
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2017-03-27 22:14:47 +00:00
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2020-08-14 00:38:12 +00:00
|
|
|
# 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_`.
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [String] topic
|
2020-08-14 00:38:12 +00:00
|
|
|
# Required. Name of the topic to delete. Format is `projects/`project`/topics/`
|
|
|
|
|
# topic``.
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
2017-03-31 19:53:27 +00:00
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::Empty] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::PubsubV1::Empty]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def delete_topic(topic, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:delete, 'v1/{+topic}', options)
|
2017-08-25 19:54:22 +00:00
|
|
|
command.response_representation = Google::Apis::PubsubV1::Empty::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::Empty
|
|
|
|
|
command.params['topic'] = topic unless topic.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
# Gets the configuration of a topic.
|
|
|
|
|
# @param [String] topic
|
2020-08-14 00:38:12 +00:00
|
|
|
# Required. The name of the topic to get. Format is `projects/`project`/topics/`
|
|
|
|
|
# topic``.
|
2017-06-14 17:02:03 +00:00
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
2017-03-31 19:53:27 +00:00
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2017-08-25 19:54:22 +00:00
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::Topic] parsed result object
|
2017-03-31 19:53:27 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
2017-08-25 19:54:22 +00:00
|
|
|
# @return [Google::Apis::PubsubV1::Topic]
|
2017-03-31 19:53:27 +00:00
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2017-08-25 19:54:22 +00:00
|
|
|
def get_topic(topic, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:get, 'v1/{+topic}', options)
|
2017-08-25 19:54:22 +00:00
|
|
|
command.response_representation = Google::Apis::PubsubV1::Topic::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::Topic
|
|
|
|
|
command.params['topic'] = topic unless topic.nil?
|
2017-06-14 17:02:03 +00:00
|
|
|
command.query['fields'] = fields unless fields.nil?
|
2017-08-25 19:54:22 +00:00
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2017-02-03 19:29:28 +00:00
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2020-08-14 00:38:12 +00:00
|
|
|
# Gets the access control policy for a resource. Returns an empty policy if the
|
|
|
|
|
# resource exists and does not have a policy set.
|
2017-06-14 17:02:03 +00:00
|
|
|
# @param [String] resource
|
2020-08-14 00:38:12 +00:00
|
|
|
# REQUIRED: The resource for which the policy is being requested. See the
|
|
|
|
|
# operation documentation for the appropriate value for this field.
|
2019-07-12 00:38:14 +00:00
|
|
|
# @param [Fixnum] options_requested_policy_version
|
2020-08-14 00:38:12 +00:00
|
|
|
# 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](https://cloud.google.com/iam/help/conditions/
|
|
|
|
|
# resource-policies).
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
2017-05-26 16:44:32 +00:00
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2017-06-14 17:02:03 +00:00
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::Policy] parsed result object
|
2017-05-26 16:44:32 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
2017-06-14 17:02:03 +00:00
|
|
|
# @return [Google::Apis::PubsubV1::Policy]
|
2017-05-26 16:44:32 +00:00
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2019-07-12 00:38:14 +00:00
|
|
|
def get_project_topic_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
|
2017-06-14 17:02:03 +00:00
|
|
|
command.response_representation = Google::Apis::PubsubV1::Policy::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::Policy
|
|
|
|
|
command.params['resource'] = resource unless resource.nil?
|
2019-07-12 00:38:14 +00:00
|
|
|
command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
|
2017-06-14 17:02:03 +00:00
|
|
|
command.query['fields'] = fields unless fields.nil?
|
2017-08-25 19:54:22 +00:00
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2017-06-14 17:02:03 +00:00
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2017-08-25 19:54:22 +00:00
|
|
|
# Lists matching topics.
|
|
|
|
|
# @param [String] project
|
2020-08-14 00:38:12 +00:00
|
|
|
# Required. The name of the project in which to list topics. Format is `projects/
|
|
|
|
|
# `project-id``.
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [Fixnum] page_size
|
|
|
|
|
# Maximum number of topics to return.
|
|
|
|
|
# @param [String] page_token
|
2020-08-14 00:38:12 +00:00
|
|
|
# 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.
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
2015-12-03 01:10:07 +00:00
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2017-08-25 19:54:22 +00:00
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::ListTopicsResponse] parsed result object
|
2015-12-03 01:10:07 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
2017-08-25 19:54:22 +00:00
|
|
|
# @return [Google::Apis::PubsubV1::ListTopicsResponse]
|
2015-12-03 01:10:07 +00:00
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2017-08-25 19:54:22 +00:00
|
|
|
def list_topics(project, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:get, 'v1/{+project}/topics', options)
|
2017-08-25 19:54:22 +00:00
|
|
|
command.response_representation = Google::Apis::PubsubV1::ListTopicsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::ListTopicsResponse
|
|
|
|
|
command.params['project'] = project unless project.nil?
|
|
|
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
|
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
2017-06-14 17:02:03 +00:00
|
|
|
command.query['fields'] = fields unless fields.nil?
|
2017-08-25 19:54:22 +00:00
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2015-12-03 01:10:07 +00:00
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2020-08-14 00:38:12 +00:00
|
|
|
# Updates an existing topic. Note that certain properties of a topic are not
|
|
|
|
|
# modifiable.
|
2018-07-04 00:36:45 +00:00
|
|
|
# @param [String] name
|
2020-08-14 00:38:12 +00:00
|
|
|
# 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"`.
|
2018-07-04 00:36:45 +00:00
|
|
|
# @param [Google::Apis::PubsubV1::UpdateTopicRequest] update_topic_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::Topic] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::PubsubV1::Topic]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def patch_project_topic(name, update_topic_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:patch, 'v1/{+name}', options)
|
2018-07-04 00:36:45 +00:00
|
|
|
command.request_representation = Google::Apis::PubsubV1::UpdateTopicRequest::Representation
|
|
|
|
|
command.request_object = update_topic_request_object
|
|
|
|
|
command.response_representation = Google::Apis::PubsubV1::Topic::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::Topic
|
|
|
|
|
command.params['name'] = name unless name.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2020-08-14 00:38:12 +00:00
|
|
|
# Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does
|
|
|
|
|
# not exist.
|
2017-06-14 17:02:03 +00:00
|
|
|
# @param [String] topic
|
2020-08-14 00:38:12 +00:00
|
|
|
# Required. The messages in the request will be published on this topic. Format
|
|
|
|
|
# is `projects/`project`/topics/`topic``.
|
2017-06-14 17:02:03 +00:00
|
|
|
# @param [Google::Apis::PubsubV1::PublishRequest] publish_request_object
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
2015-12-03 01:10:07 +00:00
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2017-06-14 17:02:03 +00:00
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::PublishResponse] parsed result object
|
2015-12-03 01:10:07 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
2017-06-14 17:02:03 +00:00
|
|
|
# @return [Google::Apis::PubsubV1::PublishResponse]
|
2015-12-03 01:10:07 +00:00
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2017-08-25 19:54:22 +00:00
|
|
|
def publish_topic(topic, publish_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:post, 'v1/{+topic}:publish', options)
|
2017-06-14 17:02:03 +00:00
|
|
|
command.request_representation = Google::Apis::PubsubV1::PublishRequest::Representation
|
|
|
|
|
command.request_object = publish_request_object
|
|
|
|
|
command.response_representation = Google::Apis::PubsubV1::PublishResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::PublishResponse
|
|
|
|
|
command.params['topic'] = topic unless topic.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
2017-08-25 19:54:22 +00:00
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2015-12-03 01:10:07 +00:00
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2017-08-25 19:54:22 +00:00
|
|
|
# Sets the access control policy on the specified resource. Replaces any
|
2020-08-14 00:38:12 +00:00
|
|
|
# existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `
|
|
|
|
|
# PERMISSION_DENIED` errors.
|
2017-06-14 17:02:03 +00:00
|
|
|
# @param [String] resource
|
2020-08-14 00:38:12 +00:00
|
|
|
# REQUIRED: The resource for which the policy is being specified. See the
|
|
|
|
|
# operation documentation for the appropriate value for this field.
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [Google::Apis::PubsubV1::SetIamPolicyRequest] set_iam_policy_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
2017-01-28 03:38:40 +00:00
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2017-08-25 19:54:22 +00:00
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::Policy] parsed result object
|
2017-01-28 03:38:40 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
2017-08-25 19:54:22 +00:00
|
|
|
# @return [Google::Apis::PubsubV1::Policy]
|
2017-01-28 03:38:40 +00:00
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2017-08-25 19:54:22 +00:00
|
|
|
def set_topic_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
|
2017-08-25 19:54:22 +00:00
|
|
|
command.request_representation = Google::Apis::PubsubV1::SetIamPolicyRequest::Representation
|
|
|
|
|
command.request_object = set_iam_policy_request_object
|
|
|
|
|
command.response_representation = Google::Apis::PubsubV1::Policy::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::Policy
|
2017-06-14 17:02:03 +00:00
|
|
|
command.params['resource'] = resource unless resource.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
2017-08-25 19:54:22 +00:00
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2017-01-28 03:38:40 +00:00
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2020-08-14 00:38:12 +00:00
|
|
|
# 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.
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [String] resource
|
2020-08-14 00:38:12 +00:00
|
|
|
# REQUIRED: The resource for which the policy detail is being requested. See the
|
|
|
|
|
# operation documentation for the appropriate value for this field.
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [Google::Apis::PubsubV1::TestIamPermissionsRequest] test_iam_permissions_request_object
|
|
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
2017-05-04 19:35:56 +00:00
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2017-08-25 19:54:22 +00:00
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::TestIamPermissionsResponse] parsed result object
|
2017-05-04 19:35:56 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
2017-08-25 19:54:22 +00:00
|
|
|
# @return [Google::Apis::PubsubV1::TestIamPermissionsResponse]
|
2017-05-04 19:35:56 +00:00
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2017-08-25 19:54:22 +00:00
|
|
|
def test_topic_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
|
2017-08-25 19:54:22 +00:00
|
|
|
command.request_representation = Google::Apis::PubsubV1::TestIamPermissionsRequest::Representation
|
|
|
|
|
command.request_object = test_iam_permissions_request_object
|
|
|
|
|
command.response_representation = Google::Apis::PubsubV1::TestIamPermissionsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::TestIamPermissionsResponse
|
|
|
|
|
command.params['resource'] = resource unless resource.nil?
|
2017-06-14 17:02:03 +00:00
|
|
|
command.query['fields'] = fields unless fields.nil?
|
2017-08-25 19:54:22 +00:00
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2017-05-04 19:35:56 +00:00
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2020-08-14 00:38:12 +00:00
|
|
|
# Lists the names of the snapshots on this topic. Snapshots are used in [Seek](
|
|
|
|
|
# https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow
|
|
|
|
|
# you to manage message acknowledgments in bulk. That is, you can set the
|
|
|
|
|
# acknowledgment state of messages in an existing subscription to the state
|
|
|
|
|
# captured by a snapshot.
|
2017-12-02 00:36:26 +00:00
|
|
|
# @param [String] topic
|
2020-08-14 00:38:12 +00:00
|
|
|
# Required. The name of the topic that snapshots are attached to. Format is `
|
|
|
|
|
# projects/`project`/topics/`topic``.
|
2017-12-02 00:36:26 +00:00
|
|
|
# @param [Fixnum] page_size
|
|
|
|
|
# Maximum number of snapshot names to return.
|
|
|
|
|
# @param [String] page_token
|
2020-08-14 00:38:12 +00:00
|
|
|
# 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.
|
2017-12-02 00:36:26 +00:00
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
|
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
|
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
|
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::ListTopicSnapshotsResponse] parsed result object
|
|
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
|
|
|
|
# @return [Google::Apis::PubsubV1::ListTopicSnapshotsResponse]
|
|
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
|
|
|
|
def list_project_topic_snapshots(topic, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:get, 'v1/{+topic}/snapshots', options)
|
2017-12-02 00:36:26 +00:00
|
|
|
command.response_representation = Google::Apis::PubsubV1::ListTopicSnapshotsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::ListTopicSnapshotsResponse
|
|
|
|
|
command.params['topic'] = topic unless topic.nil?
|
|
|
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
|
|
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
|
|
|
|
command.query['fields'] = fields unless fields.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
2020-06-05 00:39:06 +00:00
|
|
|
# Lists the names of the attached subscriptions on this topic.
|
2017-06-14 17:02:03 +00:00
|
|
|
# @param [String] topic
|
2020-08-14 00:38:12 +00:00
|
|
|
# Required. The name of the topic that subscriptions are attached to. Format is `
|
|
|
|
|
# projects/`project`/topics/`topic``.
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [Fixnum] page_size
|
|
|
|
|
# Maximum number of subscription names to return.
|
2017-06-14 17:02:03 +00:00
|
|
|
# @param [String] page_token
|
|
|
|
|
# The value returned by the last `ListTopicSubscriptionsResponse`; indicates
|
2020-08-14 00:38:12 +00:00
|
|
|
# that this is a continuation of a prior `ListTopicSubscriptions` call, and that
|
|
|
|
|
# the system should return the next page of data.
|
2017-08-25 19:54:22 +00:00
|
|
|
# @param [String] fields
|
|
|
|
|
# Selector specifying which fields to include in a partial response.
|
2017-01-28 03:38:40 +00:00
|
|
|
# @param [String] quota_user
|
|
|
|
|
# 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.
|
2015-12-03 01:10:07 +00:00
|
|
|
# @param [Google::Apis::RequestOptions] options
|
|
|
|
|
# Request-specific options
|
|
|
|
|
#
|
|
|
|
|
# @yield [result, err] Result & error if block supplied
|
2017-06-14 17:02:03 +00:00
|
|
|
# @yieldparam result [Google::Apis::PubsubV1::ListTopicSubscriptionsResponse] parsed result object
|
2015-12-03 01:10:07 +00:00
|
|
|
# @yieldparam err [StandardError] error object if request failed
|
|
|
|
|
#
|
2017-06-14 17:02:03 +00:00
|
|
|
# @return [Google::Apis::PubsubV1::ListTopicSubscriptionsResponse]
|
2015-12-03 01:10:07 +00:00
|
|
|
#
|
|
|
|
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
|
|
|
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
|
|
|
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
2017-08-25 19:54:22 +00:00
|
|
|
def list_topic_subscriptions(topic, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
2019-05-10 00:37:26 +00:00
|
|
|
command = make_simple_command(:get, 'v1/{+topic}/subscriptions', options)
|
2017-06-14 17:02:03 +00:00
|
|
|
command.response_representation = Google::Apis::PubsubV1::ListTopicSubscriptionsResponse::Representation
|
|
|
|
|
command.response_class = Google::Apis::PubsubV1::ListTopicSubscriptionsResponse
|
|
|
|
|
command.params['topic'] = topic unless topic.nil?
|
|
|
|
|
command.query['pageSize'] = page_size unless page_size.nil?
|
2017-08-25 19:54:22 +00:00
|
|
|
command.query['pageToken'] = page_token unless page_token.nil?
|
2017-06-14 17:02:03 +00:00
|
|
|
command.query['fields'] = fields unless fields.nil?
|
2017-08-25 19:54:22 +00:00
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
2015-12-03 01:10:07 +00:00
|
|
|
execute_or_queue_command(command, &block)
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
protected
|
|
|
|
|
|
|
|
|
|
def apply_command_defaults(command)
|
|
|
|
|
command.query['key'] = key unless key.nil?
|
|
|
|
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
end
|
