Class: Google::Apis::ServicenetworkingV1beta::ServiceNetworkingService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/servicenetworking_v1beta/service.rb

Overview

Service Networking API

Provides automatic management of network configurations necessary for certain services.

Examples:

require 'google/apis/servicenetworking_v1beta'

Servicenetworking = Google::Apis::ServicenetworkingV1beta # Alias the module
service = Servicenetworking::ServiceNetworkingService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ServiceNetworkingService

Returns a new instance of ServiceNetworkingService.



46
47
48
49
50
51
 
# File 'lib/google/apis/servicenetworking_v1beta/service.rb', line 46

def initialize
  super('https://servicenetworking.googleapis.com/', '',
        client_name: 'google-apis-servicenetworking_v1beta',
        client_version: Google::Apis::ServicenetworkingV1beta::GEM_VERSION)
  @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.

Returns:

  • (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.



39
40
41
 
# File 'lib/google/apis/servicenetworking_v1beta/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.

Returns:

  • (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.



44
45
46
 
# File 'lib/google/apis/servicenetworking_v1beta/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::ServicenetworkingV1beta::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.

Parameters:

  • parent (String) —

    Required. A tenant project in the service producer organization, in the following format: services/service/collection-id/resource-id. collection-id is the cloud resource collection type that represents the tenant project. Only projects are supported. resource-id is the tenant project numeric id, such as 123456. service the name of the peering service, such as service-peering.example.com. This service must already be enabled in the service consumer's project.

  • add_subnetwork_request_object (Google::Apis::ServicenetworkingV1beta::AddSubnetworkRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/google/apis/servicenetworking_v1beta/service.rb', line 119

def add_service_subnetwork(parent, add_subnetwork_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/{+parent}:addSubnetwork', options)
  command.request_representation = Google::Apis::ServicenetworkingV1beta::AddSubnetworkRequest::Representation
  command.request_object = add_subnetwork_request_object
  command.response_representation = Google::Apis::ServicenetworkingV1beta::Operation::Representation
  command.response_class = Google::Apis::ServicenetworkingV1beta::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

#create_service_connection(parent, google_cloud_servicenetworking_v1beta_connection_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1beta::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.

Parameters:

  • parent (String) —

    The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is services/servicenetworking.googleapis.com.

  • google_cloud_servicenetworking_v1beta_connection_object (Google::Apis::ServicenetworkingV1beta::GoogleCloudServicenetworkingV1betaConnection) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/google/apis/servicenetworking_v1beta/service.rb', line 244

def create_service_connection(parent, google_cloud_servicenetworking_v1beta_connection_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/{+parent}/connections', options)
  command.request_representation = Google::Apis::ServicenetworkingV1beta::GoogleCloudServicenetworkingV1betaConnection::Representation
  command.request_object = google_cloud_servicenetworking_v1beta_connection_object
  command.response_representation = Google::Apis::ServicenetworkingV1beta::Operation::Representation
  command.response_class = Google::Apis::ServicenetworkingV1beta::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::ServicenetworkingV1beta::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.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



74
75
76
77
78
79
80
81
82
 
# File 'lib/google/apis/servicenetworking_v1beta/service.rb', line 74

def get_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta/{+name}', options)
  command.response_representation = Google::Apis::ServicenetworkingV1beta::Operation::Representation
  command.response_class = Google::Apis::ServicenetworkingV1beta::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_service_connections(parent, network: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1beta::ListConnectionsResponse

List the private connections that are configured in a service consumer's VPC network.

Parameters:

  • parent (String) —

    The service that is managing peering connectivity for a service producer's organization. For Google services that support this functionality, this value is services/servicenetworking.googleapis.com. If you specify - as the parameter value, all configured public peering services are listed.

  • network (String) (defaults to: nil) —

    The name of service consumer's VPC network that's connected with service producer network through a private connection. The network name must be in the following format: projects/project/global/networks/network`.projectis a project number, such as in12345that includes the VPC service consumer's VPC network.network` is the name of the service consumer's VPC network.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



286
287
288
289
290
291
292
293
294
295
 
# File 'lib/google/apis/servicenetworking_v1beta/service.rb', line 286

def list_service_connections(parent, network: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta/{+parent}/connections', options)
  command.response_representation = Google::Apis::ServicenetworkingV1beta::ListConnectionsResponse::Representation
  command.response_class = Google::Apis::ServicenetworkingV1beta::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

#search_service_range(parent, search_range_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1beta::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

Parameters:

  • parent (String) —

    Required. This is in a form services/service. service the name of the private access management service, for example 'service-peering.example.com'.

  • search_range_request_object (Google::Apis::ServicenetworkingV1beta::SearchRangeRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/google/apis/servicenetworking_v1beta/service.rb', line 157

def search_service_range(parent, search_range_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta/{+parent}:searchRange', options)
  command.request_representation = Google::Apis::ServicenetworkingV1beta::SearchRangeRequest::Representation
  command.request_object = search_range_request_object
  command.response_representation = Google::Apis::ServicenetworkingV1beta::Operation::Representation
  command.response_class = Google::Apis::ServicenetworkingV1beta::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

#update_service_connections(name, google_cloud_servicenetworking_v1beta_connection_object = nil, force: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1beta::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.

Parameters:

  • name (String) —

    The service producer peering service that is managing peering connectivity for a service producer organization. For Google services that support this functionality, this is services/servicenetworking.googleapis.com.

  • google_cloud_servicenetworking_v1beta_connection_object (Google::Apis::ServicenetworkingV1beta::GoogleCloudServicenetworkingV1betaConnection) (defaults to: nil)
  • force (Boolean) (defaults to: nil) —

    If a previously defined allocated range is removed, force flag must be set to true.

  • update_mask (String) (defaults to: nil) —

    The update mask. If this is omitted, it defaults to "*". You can only update the listed peering ranges.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    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.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/google/apis/servicenetworking_v1beta/service.rb', line 200

def update_service_connections(name, google_cloud_servicenetworking_v1beta_connection_object = nil, force: nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta/{+name}/connections', options)
  command.request_representation = Google::Apis::ServicenetworkingV1beta::GoogleCloudServicenetworkingV1betaConnection::Representation
  command.request_object = google_cloud_servicenetworking_v1beta_connection_object
  command.response_representation = Google::Apis::ServicenetworkingV1beta::Operation::Representation
  command.response_class = Google::Apis::ServicenetworkingV1beta::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