Class: Google::Apis::ServicenetworkingV1::ServiceNetworkingService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::ServicenetworkingV1::ServiceNetworkingService
- Defined in:
- generated/google/apis/servicenetworking_v1/service.rb
Overview
Service Networking API
Provides automatic management of network configurations necessary for certain services.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Attributes inherited from Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary collapse
-
#add_service_subnetwork(parent, add_subnetwork_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::Operation
For service producers, provisions a new subnet in a peered service's shared VPC network in the requested region and with the requested size that's expressed as a CIDR range (number of leading bits of ipV4 network mask).
-
#cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::Empty
Starts asynchronous cancellation on a long-running operation.
-
#create_service_connection(parent, connection_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::Operation
Creates a private connection that establishes a VPC Network Peering connection to a VPC network in the service producer's organization.
-
#delete_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::Empty
Deletes a long-running operation.
-
#disable_vpc_service_controls(parent, disable_vpc_service_controls_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::Operation
Disables VPC service controls for a connection.
-
#enable_vpc_service_controls(parent, enable_vpc_service_controls_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::Operation
Enables VPC service controls for a connection.
-
#get_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::Operation
Gets the latest state of a long-running operation.
-
#initialize ⇒ ServiceNetworkingService
constructor
A new instance of ServiceNetworkingService.
-
#list_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::ListOperationsResponse
Lists operations that match the specified filter in the request.
-
#list_service_connections(parent, network: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::ListConnectionsResponse
List the private connections that are configured in a service consumer's VPC network.
-
#patch_service_connection(name, connection_object = nil, force: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::Operation
Updates the allocated ranges that are assigned to a connection.
-
#search_service_range(parent, search_range_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::Operation
Service producers can use this method to find a currently unused range within consumer allocated ranges.
-
#validate_service_consumer_config(parent, validate_consumer_config_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::ValidateConsumerConfigResponse
Service producers use this method to validate if the consumer provided network, project and the requested range is valid.
Methods inherited from Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Methods included from Core::Logging
Constructor Details
#initialize ⇒ ServiceNetworkingService
Returns a new instance of ServiceNetworkingService.
46 47 48 49 |
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 46 def initialize super('https://servicenetworking.googleapis.com/', '') @batch_path = 'batch' end |
Instance Attribute Details
#key ⇒ String
Returns 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.
39 40 41 |
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 39 def key @key end |
#quota_user ⇒ String
Returns 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.
44 45 46 |
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 44 def quota_user @quota_user end |
Instance Method Details
#add_service_subnetwork(parent, add_subnetwork_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::Operation
For service producers, provisions a new subnet in a
peered service's shared VPC network in the requested region and with the
requested size that's expressed as a CIDR range (number of leading bits of
ipV4 network mask). The method checks against the assigned allocated ranges
to find a non-conflicting IP address range. The method will reuse a subnet
if subsequent calls contain the same subnet name, region, and prefix
length. This method will make producer's tenant project to be a shared VPC
service project as needed. The response from the get
operation will be of
type Subnetwork
if the operation successfully completes.
241 242 243 244 245 246 247 248 249 250 251 |
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 241 def add_service_subnetwork(parent, add_subnetwork_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}:addSubnetwork', ) command.request_representation = Google::Apis::ServicenetworkingV1::AddSubnetworkRequest::Representation command.request_object = add_subnetwork_request_object command.response_representation = Google::Apis::ServicenetworkingV1::Operation::Representation command.response_class = Google::Apis::ServicenetworkingV1::Operation command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::Empty
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
.
81 82 83 84 85 86 87 88 89 90 91 |
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 81 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', ) command.request_representation = Google::Apis::ServicenetworkingV1::CancelOperationRequest::Representation command.request_object = cancel_operation_request_object command.response_representation = Google::Apis::ServicenetworkingV1::Empty::Representation command.response_class = Google::Apis::ServicenetworkingV1::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 |
#create_service_connection(parent, connection_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::Operation
Creates a private connection that establishes a VPC Network Peering
connection to a VPC network in the service producer's organization.
The administrator of the service consumer's VPC network invokes this
method. The administrator must assign one or more allocated IP ranges for
provisioning subnetworks in the service producer's VPC network. This
connection is used for all supported services in the service producer's
organization, so it only needs to be invoked once. The response from the
get
operation will be of type Connection
if the operation successfully
completes.
435 436 437 438 439 440 441 442 443 444 445 |
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 435 def create_service_connection(parent, connection_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/connections', ) command.request_representation = Google::Apis::ServicenetworkingV1::Connection::Representation command.request_object = connection_object command.response_representation = Google::Apis::ServicenetworkingV1::Operation::Representation command.response_class = Google::Apis::ServicenetworkingV1::Operation command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::Empty
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
.
116 117 118 119 120 121 122 123 124 |
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 116 def delete_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) command.response_representation = Google::Apis::ServicenetworkingV1::Empty::Representation command.response_class = Google::Apis::ServicenetworkingV1::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 |
#disable_vpc_service_controls(parent, disable_vpc_service_controls_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::Operation
Disables VPC service controls for a connection.
276 277 278 279 280 281 282 283 284 285 286 |
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 276 def disable_vpc_service_controls(parent, disable_vpc_service_controls_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/{+parent}:disableVpcServiceControls', ) command.request_representation = Google::Apis::ServicenetworkingV1::DisableVpcServiceControlsRequest::Representation command.request_object = disable_vpc_service_controls_request_object command.response_representation = Google::Apis::ServicenetworkingV1::Operation::Representation command.response_class = Google::Apis::ServicenetworkingV1::Operation command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#enable_vpc_service_controls(parent, enable_vpc_service_controls_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::Operation
Enables VPC service controls for a connection.
311 312 313 314 315 316 317 318 319 320 321 |
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 311 def enable_vpc_service_controls(parent, enable_vpc_service_controls_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/{+parent}:enableVpcServiceControls', ) command.request_representation = Google::Apis::ServicenetworkingV1::EnableVpcServiceControlsRequest::Representation command.request_object = enable_vpc_service_controls_request_object command.response_representation = Google::Apis::ServicenetworkingV1::Operation::Representation command.response_class = Google::Apis::ServicenetworkingV1::Operation command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::Operation
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.
148 149 150 151 152 153 154 155 156 |
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 148 def get_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::ServicenetworkingV1::Operation::Representation command.response_class = Google::Apis::ServicenetworkingV1::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 |
#list_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::ListOperationsResponse
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.
192 193 194 195 196 197 198 199 200 201 202 203 |
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 192 def list_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}', ) command.response_representation = Google::Apis::ServicenetworkingV1::ListOperationsResponse::Representation command.response_class = Google::Apis::ServicenetworkingV1::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 |
#list_service_connections(parent, network: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::ListConnectionsResponse
List the private connections that are configured in a service consumer's VPC network.
480 481 482 483 484 485 486 487 488 489 |
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 480 def list_service_connections(parent, network: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/connections', ) command.response_representation = Google::Apis::ServicenetworkingV1::ListConnectionsResponse::Representation command.response_class = Google::Apis::ServicenetworkingV1::ListConnectionsResponse command.params['parent'] = parent unless parent.nil? command.query['network'] = network unless network.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#patch_service_connection(name, connection_object = nil, force: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::Operation
Updates the allocated ranges that are assigned to a connection.
The response from the get
operation will be of type Connection
if the
operation successfully completes.
526 527 528 529 530 531 532 533 534 535 536 537 538 |
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 526 def patch_service_connection(name, connection_object = nil, force: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/{+name}', ) command.request_representation = Google::Apis::ServicenetworkingV1::Connection::Representation command.request_object = connection_object command.response_representation = Google::Apis::ServicenetworkingV1::Operation::Representation command.response_class = Google::Apis::ServicenetworkingV1::Operation command.params['name'] = name unless name.nil? command.query['force'] = force unless force.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 |
#search_service_range(parent, search_range_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::Operation
Service producers can use this method to find a currently unused range
within consumer allocated ranges. This returned range is not reserved,
and not guaranteed to remain unused.
It will validate previously provided allocated ranges, find
non-conflicting sub-range of requested size (expressed in
number of leading bits of ipv4 network mask, as in CIDR range
notation).
Operation
353 354 355 356 357 358 359 360 361 362 363 |
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 353 def search_service_range(parent, search_range_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}:searchRange', ) command.request_representation = Google::Apis::ServicenetworkingV1::SearchRangeRequest::Representation command.request_object = search_range_request_object command.response_representation = Google::Apis::ServicenetworkingV1::Operation::Representation command.response_class = Google::Apis::ServicenetworkingV1::Operation command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#validate_service_consumer_config(parent, validate_consumer_config_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::ValidateConsumerConfigResponse
Service producers use this method to validate if the consumer provided network, project and the requested range is valid. This allows them to use a fail-fast mechanism for consumer requests, and not have to wait for AddSubnetwork operation completion to determine if user request is invalid.
392 393 394 395 396 397 398 399 400 401 402 |
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 392 def validate_service_consumer_config(parent, validate_consumer_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}:validate', ) command.request_representation = Google::Apis::ServicenetworkingV1::ValidateConsumerConfigRequest::Representation command.request_object = validate_consumer_config_request_object command.response_representation = Google::Apis::ServicenetworkingV1::ValidateConsumerConfigResponse::Representation command.response_class = Google::Apis::ServicenetworkingV1::ValidateConsumerConfigResponse command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |