668 lines
40 KiB
Ruby
668 lines
40 KiB
Ruby
|
# 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 NetworkmanagementV1
|
||
|
# Network Management API
|
||
|
#
|
||
|
# The Network Management API provides a collection of network performance
|
||
|
# monitoring and diagnostic capabilities.
|
||
|
#
|
||
|
# @example
|
||
|
# require 'google/apis/networkmanagement_v1'
|
||
|
#
|
||
|
# Networkmanagement = Google::Apis::NetworkmanagementV1 # Alias the module
|
||
|
# service = Networkmanagement::NetworkManagementService.new
|
||
|
#
|
||
|
# @see https://cloud.google.com/
|
||
|
class NetworkManagementService < 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://networkmanagement.googleapis.com/', '')
|
||
|
@batch_path = 'batch'
|
||
|
end
|
||
|
|
||
|
# Gets information about a location.
|
||
|
# @param [String] name
|
||
|
# Resource name for the location.
|
||
|
# @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::NetworkmanagementV1::Location] parsed result object
|
||
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
#
|
||
|
# @return [Google::Apis::NetworkmanagementV1::Location]
|
||
|
#
|
||
|
# @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_location(name, fields: nil, quota_user: nil, options: nil, &block)
|
||
|
command = make_simple_command(:get, 'v1/{+name}', options)
|
||
|
command.response_representation = Google::Apis::NetworkmanagementV1::Location::Representation
|
||
|
command.response_class = Google::Apis::NetworkmanagementV1::Location
|
||
|
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
|
||
|
|
||
|
# Lists information about the supported locations for this service.
|
||
|
# @param [String] name
|
||
|
# The resource that owns the locations collection, if applicable.
|
||
|
# @param [String] filter
|
||
|
# The standard list filter.
|
||
|
# @param [Fixnum] page_size
|
||
|
# The standard list page size.
|
||
|
# @param [String] page_token
|
||
|
# The standard list page token.
|
||
|
# @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::NetworkmanagementV1::ListLocationsResponse] parsed result object
|
||
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
#
|
||
|
# @return [Google::Apis::NetworkmanagementV1::ListLocationsResponse]
|
||
|
#
|
||
|
# @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_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
||
|
command = make_simple_command(:get, 'v1/{+name}/locations', options)
|
||
|
command.response_representation = Google::Apis::NetworkmanagementV1::ListLocationsResponse::Representation
|
||
|
command.response_class = Google::Apis::NetworkmanagementV1::ListLocationsResponse
|
||
|
command.params['name'] = name unless name.nil?
|
||
|
command.query['filter'] = filter unless filter.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
|
||
|
|
||
|
# Creates a new Connectivity Test.
|
||
|
# After you create a test, the reachability analysis is performed as part
|
||
|
# of the long running operation, which completes when the analysis completes.
|
||
|
# If the endpoint specifications in `ConnectivityTest` are invalid
|
||
|
# (for example, containing non-existent resources in the network, or you
|
||
|
# don't have read permissions to the network configurations of listed
|
||
|
# projects), then the reachability result returns a value of `UNKNOWN`.
|
||
|
# If the endpoint specifications in `ConnectivityTest` are
|
||
|
# incomplete, the reachability result returns a value of
|
||
|
# <code>AMBIGUOUS</code>. For more information,
|
||
|
# see the Connectivity Test documentation.
|
||
|
# @param [String] parent
|
||
|
# Required. The parent resource of the Connectivity Test to create:
|
||
|
# `projects/`project_id`/locations/global`
|
||
|
# @param [Google::Apis::NetworkmanagementV1::ConnectivityTest] connectivity_test_object
|
||
|
# @param [String] test_id
|
||
|
# Required. The logical name of the Connectivity Test in your project
|
||
|
# with the following restrictions:
|
||
|
# * Must contain only lowercase letters, numbers, and hyphens.
|
||
|
# * Must start with a letter.
|
||
|
# * Must be between 1-40 characters.
|
||
|
# * Must end with a number or a letter.
|
||
|
# * Must be unique within the customer project
|
||
|
# @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::NetworkmanagementV1::Operation] parsed result object
|
||
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
#
|
||
|
# @return [Google::Apis::NetworkmanagementV1::Operation]
|
||
|
#
|
||
|
# @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_project_location_global_connectivity_test(parent, connectivity_test_object = nil, test_id: nil, fields: nil, quota_user: nil, options: nil, &block)
|
||
|
command = make_simple_command(:post, 'v1/{+parent}/connectivityTests', options)
|
||
|
command.request_representation = Google::Apis::NetworkmanagementV1::ConnectivityTest::Representation
|
||
|
command.request_object = connectivity_test_object
|
||
|
command.response_representation = Google::Apis::NetworkmanagementV1::Operation::Representation
|
||
|
command.response_class = Google::Apis::NetworkmanagementV1::Operation
|
||
|
command.params['parent'] = parent unless parent.nil?
|
||
|
command.query['testId'] = test_id unless test_id.nil?
|
||
|
command.query['fields'] = fields unless fields.nil?
|
||
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||
|
execute_or_queue_command(command, &block)
|
||
|
end
|
||
|
|
||
|
# Deletes a specific `ConnectivityTest`.
|
||
|
# @param [String] name
|
||
|
# Required. Connectivity Test resource name using the form:
|
||
|
# `projects/`project_id`/locations/global/connectivityTests/`test_id``
|
||
|
# @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::NetworkmanagementV1::Operation] parsed result object
|
||
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
#
|
||
|
# @return [Google::Apis::NetworkmanagementV1::Operation]
|
||
|
#
|
||
|
# @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_location_global_connectivity_test(name, fields: nil, quota_user: nil, options: nil, &block)
|
||
|
command = make_simple_command(:delete, 'v1/{+name}', options)
|
||
|
command.response_representation = Google::Apis::NetworkmanagementV1::Operation::Representation
|
||
|
command.response_class = Google::Apis::NetworkmanagementV1::Operation
|
||
|
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
|
||
|
|
||
|
# Gets the details of a specific Connectivity Test.
|
||
|
# @param [String] name
|
||
|
# Required. `ConnectivityTest` resource name using the form:
|
||
|
# `projects/`project_id`/locations/global/connectivityTests/`test_id``
|
||
|
# @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::NetworkmanagementV1::ConnectivityTest] parsed result object
|
||
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
#
|
||
|
# @return [Google::Apis::NetworkmanagementV1::ConnectivityTest]
|
||
|
#
|
||
|
# @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_location_global_connectivity_test(name, fields: nil, quota_user: nil, options: nil, &block)
|
||
|
command = make_simple_command(:get, 'v1/{+name}', options)
|
||
|
command.response_representation = Google::Apis::NetworkmanagementV1::ConnectivityTest::Representation
|
||
|
command.response_class = Google::Apis::NetworkmanagementV1::ConnectivityTest
|
||
|
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
|
||
|
|
||
|
# Gets the access control policy for a resource.
|
||
|
# Returns an empty policy if the resource exists and does not have a policy
|
||
|
# set.
|
||
|
# @param [String] resource
|
||
|
# REQUIRED: The resource for which the policy is being requested.
|
||
|
# See the operation documentation for the appropriate value for this field.
|
||
|
# @param [Fixnum] options_requested_policy_version
|
||
|
# 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).
|
||
|
# @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::NetworkmanagementV1::Policy] parsed result object
|
||
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
#
|
||
|
# @return [Google::Apis::NetworkmanagementV1::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
|
||
|
def get_project_location_global_connectivity_test_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
|
||
|
command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
|
||
|
command.response_representation = Google::Apis::NetworkmanagementV1::Policy::Representation
|
||
|
command.response_class = Google::Apis::NetworkmanagementV1::Policy
|
||
|
command.params['resource'] = resource unless resource.nil?
|
||
|
command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
|
||
|
command.query['fields'] = fields unless fields.nil?
|
||
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||
|
execute_or_queue_command(command, &block)
|
||
|
end
|
||
|
|
||
|
# Lists all Connectivity Tests owned by a project.
|
||
|
# @param [String] parent
|
||
|
# Required. The parent resource of the Connectivity Tests:
|
||
|
# `projects/`project_id`/locations/global`
|
||
|
# @param [String] filter
|
||
|
# Lists the `ConnectivityTests` that match the filter expression. A filter
|
||
|
# expression filters the resources listed in the response. The expression
|
||
|
# must be of the form `<field> <operator> <value>` where operators: `<`, `>`,
|
||
|
# `<=`,
|
||
|
# `>=`,
|
||
|
# `!=`, `=`, `:` are supported (colon `:` represents a HAS operator which is
|
||
|
# roughly synonymous with equality). <field> can refer to a proto or JSON
|
||
|
# field, or a synthetic field. Field names can be camelCase or snake_case.
|
||
|
# Examples:
|
||
|
# - Filter by name:
|
||
|
# name = "projects/proj-1/locations/global/connectivityTests/test-1
|
||
|
# - Filter by labels:
|
||
|
# - Resources that have a key called `foo`
|
||
|
# labels.foo:*
|
||
|
# - Resources that have a key called `foo` whose value is `bar`
|
||
|
# labels.foo = bar
|
||
|
# @param [String] order_by
|
||
|
# Field to use to sort the list.
|
||
|
# @param [Fixnum] page_size
|
||
|
# Number of `ConnectivityTests` to return.
|
||
|
# @param [String] page_token
|
||
|
# Page token from an earlier query, as returned in `next_page_token`.
|
||
|
# @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::NetworkmanagementV1::ListConnectivityTestsResponse] parsed result object
|
||
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
#
|
||
|
# @return [Google::Apis::NetworkmanagementV1::ListConnectivityTestsResponse]
|
||
|
#
|
||
|
# @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_location_global_connectivity_tests(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
||
|
command = make_simple_command(:get, 'v1/{+parent}/connectivityTests', options)
|
||
|
command.response_representation = Google::Apis::NetworkmanagementV1::ListConnectivityTestsResponse::Representation
|
||
|
command.response_class = Google::Apis::NetworkmanagementV1::ListConnectivityTestsResponse
|
||
|
command.params['parent'] = parent unless parent.nil?
|
||
|
command.query['filter'] = filter unless filter.nil?
|
||
|
command.query['orderBy'] = order_by unless order_by.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
|
||
|
|
||
|
# Updates the configuration of an existing `ConnectivityTest`.
|
||
|
# After you update a test, the reachability analysis is performed as part
|
||
|
# of the long running operation, which completes when the analysis completes.
|
||
|
# The Reachability state in the test resource is updated with the new result.
|
||
|
# If the endpoint specifications in `ConnectivityTest` are invalid
|
||
|
# (for example, they contain non-existent resources in the network, or the
|
||
|
# user does not have read permissions to the network configurations of
|
||
|
# listed projects), then the reachability result returns a value of
|
||
|
# <code>UNKNOWN</code>.
|
||
|
# If the endpoint specifications in `ConnectivityTest` are incomplete, the
|
||
|
# reachability result returns a value of `AMBIGUOUS`. See the documentation
|
||
|
# in `ConnectivityTest` for for more details.
|
||
|
# @param [String] name
|
||
|
# Required. Unique name of the resource using the form:
|
||
|
# `projects/`project_id`/locations/global/connectivityTests/`test_id``
|
||
|
# @param [Google::Apis::NetworkmanagementV1::ConnectivityTest] connectivity_test_object
|
||
|
# @param [String] update_mask
|
||
|
# Required. Mask of fields to update. At least one path must be supplied in
|
||
|
# this field.
|
||
|
# @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::NetworkmanagementV1::Operation] parsed result object
|
||
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
#
|
||
|
# @return [Google::Apis::NetworkmanagementV1::Operation]
|
||
|
#
|
||
|
# @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_location_global_connectivity_test(name, connectivity_test_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
||
|
command = make_simple_command(:patch, 'v1/{+name}', options)
|
||
|
command.request_representation = Google::Apis::NetworkmanagementV1::ConnectivityTest::Representation
|
||
|
command.request_object = connectivity_test_object
|
||
|
command.response_representation = Google::Apis::NetworkmanagementV1::Operation::Representation
|
||
|
command.response_class = Google::Apis::NetworkmanagementV1::Operation
|
||
|
command.params['name'] = name unless name.nil?
|
||
|
command.query['updateMask'] = update_mask unless update_mask.nil?
|
||
|
command.query['fields'] = fields unless fields.nil?
|
||
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||
|
execute_or_queue_command(command, &block)
|
||
|
end
|
||
|
|
||
|
# Rerun an existing `ConnectivityTest`.
|
||
|
# After the user triggers the rerun, the reachability analysis is performed
|
||
|
# as part of the long running operation, which completes when the analysis
|
||
|
# completes.
|
||
|
# Even though the test configuration remains the same, the reachability
|
||
|
# result may change due to underlying network configuration changes.
|
||
|
# If the endpoint specifications in `ConnectivityTest` become invalid (for
|
||
|
# example, specified resources are deleted in the network, or you lost
|
||
|
# read permissions to the network configurations of listed projects), then
|
||
|
# the reachability result returns a value of `UNKNOWN`.
|
||
|
# @param [String] name
|
||
|
# Required. Connectivity Test resource name using the form:
|
||
|
# `projects/`project_id`/locations/global/connectivityTests/`test_id``
|
||
|
# @param [Google::Apis::NetworkmanagementV1::RerunConnectivityTestRequest] rerun_connectivity_test_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::NetworkmanagementV1::Operation] parsed result object
|
||
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
#
|
||
|
# @return [Google::Apis::NetworkmanagementV1::Operation]
|
||
|
#
|
||
|
# @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 rerun_connectivity_test(name, rerun_connectivity_test_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
||
|
command = make_simple_command(:post, 'v1/{+name}:rerun', options)
|
||
|
command.request_representation = Google::Apis::NetworkmanagementV1::RerunConnectivityTestRequest::Representation
|
||
|
command.request_object = rerun_connectivity_test_request_object
|
||
|
command.response_representation = Google::Apis::NetworkmanagementV1::Operation::Representation
|
||
|
command.response_class = Google::Apis::NetworkmanagementV1::Operation
|
||
|
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
|
||
|
|
||
|
# Sets the access control policy on the specified resource. Replaces any
|
||
|
# existing policy.
|
||
|
# Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
|
||
|
# @param [String] resource
|
||
|
# REQUIRED: The resource for which the policy is being specified.
|
||
|
# See the operation documentation for the appropriate value for this field.
|
||
|
# @param [Google::Apis::NetworkmanagementV1::SetIamPolicyRequest] set_iam_policy_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::NetworkmanagementV1::Policy] parsed result object
|
||
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
#
|
||
|
# @return [Google::Apis::NetworkmanagementV1::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
|
||
|
def set_connectivity_test_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
||
|
command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
|
||
|
command.request_representation = Google::Apis::NetworkmanagementV1::SetIamPolicyRequest::Representation
|
||
|
command.request_object = set_iam_policy_request_object
|
||
|
command.response_representation = Google::Apis::NetworkmanagementV1::Policy::Representation
|
||
|
command.response_class = Google::Apis::NetworkmanagementV1::Policy
|
||
|
command.params['resource'] = resource unless resource.nil?
|
||
|
command.query['fields'] = fields unless fields.nil?
|
||
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||
|
execute_or_queue_command(command, &block)
|
||
|
end
|
||
|
|
||
|
# 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.
|
||
|
# @param [String] resource
|
||
|
# REQUIRED: The resource for which the policy detail is being requested.
|
||
|
# See the operation documentation for the appropriate value for this field.
|
||
|
# @param [Google::Apis::NetworkmanagementV1::TestIamPermissionsRequest] test_iam_permissions_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::NetworkmanagementV1::TestIamPermissionsResponse] parsed result object
|
||
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
#
|
||
|
# @return [Google::Apis::NetworkmanagementV1::TestIamPermissionsResponse]
|
||
|
#
|
||
|
# @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 test_connectivity_test_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
||
|
command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
|
||
|
command.request_representation = Google::Apis::NetworkmanagementV1::TestIamPermissionsRequest::Representation
|
||
|
command.request_object = test_iam_permissions_request_object
|
||
|
command.response_representation = Google::Apis::NetworkmanagementV1::TestIamPermissionsResponse::Representation
|
||
|
command.response_class = Google::Apis::NetworkmanagementV1::TestIamPermissionsResponse
|
||
|
command.params['resource'] = resource unless resource.nil?
|
||
|
command.query['fields'] = fields unless fields.nil?
|
||
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
||
|
execute_or_queue_command(command, &block)
|
||
|
end
|
||
|
|
||
|
# Starts asynchronous cancellation on a long-running operation. The server
|
||
|
# makes a best effort to cancel the operation, but success is not
|
||
|
# guaranteed. If the server doesn't support this method, it returns
|
||
|
# `google.rpc.Code.UNIMPLEMENTED`. Clients can use
|
||
|
# Operations.GetOperation or
|
||
|
# other methods to check whether the cancellation succeeded or whether the
|
||
|
# operation completed despite cancellation. On successful cancellation,
|
||
|
# the operation is not deleted; instead, it becomes an operation with
|
||
|
# an Operation.error value with a google.rpc.Status.code of 1,
|
||
|
# corresponding to `Code.CANCELLED`.
|
||
|
# @param [String] name
|
||
|
# The name of the operation resource to be cancelled.
|
||
|
# @param [Google::Apis::NetworkmanagementV1::CancelOperationRequest] cancel_operation_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::NetworkmanagementV1::Empty] parsed result object
|
||
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
#
|
||
|
# @return [Google::Apis::NetworkmanagementV1::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 cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
||
|
command = make_simple_command(:post, 'v1/{+name}:cancel', options)
|
||
|
command.request_representation = Google::Apis::NetworkmanagementV1::CancelOperationRequest::Representation
|
||
|
command.request_object = cancel_operation_request_object
|
||
|
command.response_representation = Google::Apis::NetworkmanagementV1::Empty::Representation
|
||
|
command.response_class = Google::Apis::NetworkmanagementV1::Empty
|
||
|
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
|
||
|
|
||
|
# Deletes a long-running operation. This method indicates that the client is
|
||
|
# no longer interested in the operation result. It does not cancel the
|
||
|
# operation. If the server doesn't support this method, it returns
|
||
|
# `google.rpc.Code.UNIMPLEMENTED`.
|
||
|
# @param [String] name
|
||
|
# The name of the operation resource to be deleted.
|
||
|
# @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::NetworkmanagementV1::Empty] parsed result object
|
||
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
#
|
||
|
# @return [Google::Apis::NetworkmanagementV1::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_location_global_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
||
|
command = make_simple_command(:delete, 'v1/{+name}', options)
|
||
|
command.response_representation = Google::Apis::NetworkmanagementV1::Empty::Representation
|
||
|
command.response_class = Google::Apis::NetworkmanagementV1::Empty
|
||
|
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
|
||
|
|
||
|
# Gets the latest state of a long-running operation. Clients can use this
|
||
|
# method to poll the operation result at intervals as recommended by the API
|
||
|
# service.
|
||
|
# @param [String] name
|
||
|
# The name of the operation resource.
|
||
|
# @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::NetworkmanagementV1::Operation] parsed result object
|
||
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
#
|
||
|
# @return [Google::Apis::NetworkmanagementV1::Operation]
|
||
|
#
|
||
|
# @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_location_global_operation(name, fields: nil, quota_user: nil, options: nil, &block)
|
||
|
command = make_simple_command(:get, 'v1/{+name}', options)
|
||
|
command.response_representation = Google::Apis::NetworkmanagementV1::Operation::Representation
|
||
|
command.response_class = Google::Apis::NetworkmanagementV1::Operation
|
||
|
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
|
||
|
|
||
|
# Lists operations that match the specified filter in the request. If the
|
||
|
# server doesn't support this method, it returns `UNIMPLEMENTED`.
|
||
|
# NOTE: the `name` binding allows API services to override the binding
|
||
|
# to use different resource name schemes, such as `users/*/operations`. To
|
||
|
# override the binding, API services can add a binding such as
|
||
|
# `"/v1/`name=users/*`/operations"` to their service configuration.
|
||
|
# For backwards compatibility, the default name includes the operations
|
||
|
# collection id, however overriding users must ensure the name binding
|
||
|
# is the parent resource, without the operations collection id.
|
||
|
# @param [String] name
|
||
|
# The name of the operation's parent resource.
|
||
|
# @param [String] filter
|
||
|
# The standard list filter.
|
||
|
# @param [Fixnum] page_size
|
||
|
# The standard list page size.
|
||
|
# @param [String] page_token
|
||
|
# The standard list page token.
|
||
|
# @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::NetworkmanagementV1::ListOperationsResponse] parsed result object
|
||
|
# @yieldparam err [StandardError] error object if request failed
|
||
|
#
|
||
|
# @return [Google::Apis::NetworkmanagementV1::ListOperationsResponse]
|
||
|
#
|
||
|
# @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_location_global_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
||
|
command = make_simple_command(:get, 'v1/{+name}/operations', options)
|
||
|
command.response_representation = Google::Apis::NetworkmanagementV1::ListOperationsResponse::Representation
|
||
|
command.response_class = Google::Apis::NetworkmanagementV1::ListOperationsResponse
|
||
|
command.params['name'] = name unless name.nil?
|
||
|
command.query['filter'] = filter unless filter.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
|
||
|
|
||
|
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
|