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

Inherits:
Core::BaseService
  • Object
show all
Defined in:
generated/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

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ ServiceNetworkingService

Returns a new instance of ServiceNetworkingService



46
47
48
49
 
# File 'generated/google/apis/servicenetworking_v1beta/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.

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 'generated/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 'generated/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

Service producers use this method to provision a new subnet in peered service shared VPC network. 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). It will then create a subnetwork in the request region. The subsequent call will try to reuse the subnetwork previously created if subnetwork name, region and prefix length of the IP range match. Operation

Parameters:

  • parent (String) —

    Required. This is a 'tenant' project in the service producer organization. services/service/collection-id/resource-id collection id is the cloud resource collection type representing the tenant project. Only 'projects' are currently supported. resource id is the tenant project numeric id: '123456'. service the name of the peering service, for example 'service-peering.example.com'. This service must be activated. in the consumer project.

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

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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, connection_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1beta::Operation

To connect service to a VPC network peering connection must be established prior to service provisioning. This method must be invoked by the consumer VPC network administrator It will establish a permanent peering connection with a shared network created in the service producer organization and register a allocated IP range(s) to be used for service subnetwork provisioning. This connection will be used for all supported services in the service producer organization, so it only needs to be invoked once. Operation.

Parameters:

  • parent (String) —

    Provider peering service that is managing peering connectivity for a service provider organization. For Google services that support this functionality it is 'services/servicenetworking.googleapis.com'.

  • connection_object (Google::Apis::ServicenetworkingV1beta::Connection) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



164
165
166
167
168
169
170
171
172
173
174
 
# File 'generated/google/apis/servicenetworking_v1beta/service.rb', line 164

def create_service_connection(parent, 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::Connection::Representation
  command.request_object = 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) —

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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

Service consumers use this method to list configured peering connection for the given service and consumer network.

Parameters:

  • parent (String) —

    Provider peering service that is managing peering connectivity for a service provider organization. For Google services that support this functionality it is 'services/servicenetworking.googleapis.com'.

  • network (String) —

    Network name in the consumer project. This network must have been already peered with a shared VPC network using CreateConnection method. Must be in a form 'projects/project/global/networks/network'. project is a project number, as in '12345' network is network name.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

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

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



207
208
209
210
211
212
213
214
215
216
 
# File 'generated/google/apis/servicenetworking_v1beta/service.rb', line 207

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