Class: Google::Apis::ServicenetworkingV1::ServiceNetworkingService

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

Overview

Service Networking API

Provides automatic management of network configurations necessary for certain services.

Examples:

require 'google/apis/servicenetworking_v1'

Servicenetworking = Google::Apis::ServicenetworkingV1 # 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

#initializeServiceNetworkingService

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

#keyString

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_v1/service.rb', line 39

def key
  @key
end

#quota_userString

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_v1/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#add_dns_record_set(parent, add_dns_record_set_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::Operation

Service producers can use this method to add DNS record sets to private DNS zones in the shared producer host project.

Parameters:

  • parent (String)

    Required. 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.

  • add_dns_record_set_request_object (Google::Apis::ServicenetworkingV1::AddDnsRecordSetRequest) (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:


544
545
546
547
548
549
550
551
552
553
554
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 544

def add_dns_record_set(parent, add_dns_record_set_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/dnsRecordSets:add', options)
  command.request_representation = Google::Apis::ServicenetworkingV1::AddDnsRecordSetRequest::Representation
  command.request_object = add_dns_record_set_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

#add_dns_zone(parent, add_dns_zone_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::Operation

Service producers can use this method to add private DNS zones in the shared producer host project and matching peering zones in the consumer project.

Parameters:

  • parent (String)

    Required. 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.

  • add_dns_zone_request_object (Google::Apis::ServicenetworkingV1::AddDnsZoneRequest) (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:


652
653
654
655
656
657
658
659
660
661
662
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 652

def add_dns_zone(parent, add_dns_zone_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/dnsZones:add', options)
  command.request_representation = Google::Apis::ServicenetworkingV1::AddDnsZoneRequest::Representation
  command.request_object = add_dns_zone_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

#add_roles(parent, add_roles_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::Operation

Service producers can use this method to add roles in the shared VPC host project. Each role is bound to the provided member. Each role must be selected from within a whitelisted set of roles. Each role is applied at only the granularity specified in the whitelist.

Parameters:

  • parent (String)

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

  • add_roles_request_object (Google::Apis::ServicenetworkingV1::AddRolesRequest) (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:


843
844
845
846
847
848
849
850
851
852
853
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 843

def add_roles(parent, add_roles_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/roles:add', options)
  command.request_representation = Google::Apis::ServicenetworkingV1::AddRolesRequest::Representation
  command.request_object = add_roles_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

#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.

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::ServicenetworkingV1::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:


234
235
236
237
238
239
240
241
242
243
244
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 234

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', options)
  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.

Parameters:

  • name (String)

    The name of the operation resource to be cancelled.

  • cancel_operation_request_object (Google::Apis::ServicenetworkingV1::CancelOperationRequest) (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:


79
80
81
82
83
84
85
86
87
88
89
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 79

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::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.

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.

  • connection_object (Google::Apis::ServicenetworkingV1::Connection) (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:


421
422
423
424
425
426
427
428
429
430
431
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 421

def create_service_connection(parent, connection_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/connections', options)
  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

#create_service_project_global_network_peered_dns_domain(parent, peered_dns_domain_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::Operation

Creates a peered DNS domain which sends requests for records in given namespace originating in the service producer VPC network to the consumer VPC network to be resolved.

Parameters:

  • parent (String)

    Required. Parent resource identifying the connection for which the peered DNS domain will be created in the format: services/service/projects/project/ global/networks/network`serviceis the peering service that is managing connectivity for the service producer's organization. For Google services that support this functionality, this value isservicenetworking.googleapis.com. projectis the number of the project that contains the service consumer's VPC network e.g.12345.network` is the name of the service consumer's VPC network.

  • peered_dns_domain_object (Google::Apis::ServicenetworkingV1::PeeredDnsDomain) (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:


731
732
733
734
735
736
737
738
739
740
741
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 731

def create_service_project_global_network_peered_dns_domain(parent, peered_dns_domain_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/peeredDnsDomains', options)
  command.request_representation = Google::Apis::ServicenetworkingV1::PeeredDnsDomain::Representation
  command.request_object = peered_dns_domain_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.

Parameters:

  • name (String)

    The name of the operation resource to be deleted.

  • 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:


114
115
116
117
118
119
120
121
122
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 114

def delete_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  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

#delete_service_project_global_network_peered_dns_domain(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::Operation

Deletes a peered DNS domain.

Parameters:

  • name (String)

    Required. The name of the peered DNS domain to delete in the format: services/ service/projects/project/global/networks/network/peeredDnsDomains/name` .serviceis the peering service that is managing connectivity for the service producer's organization. For Google services that support this functionality, this value isservicenetworking.googleapis.com.projectis the number of the project that contains the service consumer's VPC network e.g. 12345.networkis the name of the service consumer's VPC network.name` is the name of the peered DNS domain.

  • 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:


770
771
772
773
774
775
776
777
778
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 770

def delete_service_project_global_network_peered_dns_domain(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  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

#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.

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.

  • disable_vpc_service_controls_request_object (Google::Apis::ServicenetworkingV1::DisableVpcServiceControlsRequest) (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:


269
270
271
272
273
274
275
276
277
278
279
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 269

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', options)
  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.

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.

  • enable_vpc_service_controls_request_object (Google::Apis::ServicenetworkingV1::EnableVpcServiceControlsRequest) (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:


304
305
306
307
308
309
310
311
312
313
314
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 304

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', options)
  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.

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:


145
146
147
148
149
150
151
152
153
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 145

def get_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  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.

Parameters:

  • name (String)

    The name of the operation's parent resource.

  • filter (String) (defaults to: nil)

    The standard list filter.

  • page_size (Fixnum) (defaults to: nil)

    The standard list page size.

  • page_token (String) (defaults to: nil)

    The standard list page token.

  • 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:


188
189
190
191
192
193
194
195
196
197
198
199
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 188

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}', options)
  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.

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 services/- as the parameter value, all configured 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:


463
464
465
466
467
468
469
470
471
472
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 463

def list_service_connections(parent, network: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/connections', options)
  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

#list_service_project_global_network_peered_dns_domains(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::ListPeeredDnsDomainsResponse

Lists peered DNS domains for a connection.

Parameters:

  • parent (String)

    Required. Parent resource identifying the connection which owns this collection of peered DNS domains in the format: services/service/projects/ project/global/networks/network`.serviceis the peering service that is managing connectivity for the service producer's organization. For Google services that support this functionality, this value isservicenetworking. googleapis.com.projectis a project number e.g.12345that contains the 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:


807
808
809
810
811
812
813
814
815
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 807

def list_service_project_global_network_peered_dns_domains(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/peeredDnsDomains', options)
  command.response_representation = Google::Apis::ServicenetworkingV1::ListPeeredDnsDomainsResponse::Representation
  command.response_class = Google::Apis::ServicenetworkingV1::ListPeeredDnsDomainsResponse
  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

#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.

Parameters:

  • name (String)

    The private service connection that connects to a service producer organization. The name includes both the private service name and the VPC network peering name in the format of services/peering_service_name/ connections/vpc_peering_name`. For Google services that support this functionality, this isservices/servicenetworking.googleapis.com/connections/ servicenetworking-googleapis-com`.

  • connection_object (Google::Apis::ServicenetworkingV1::Connection) (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:


506
507
508
509
510
511
512
513
514
515
516
517
518
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 506

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}', options)
  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

#remove_dns_record_set(parent, remove_dns_record_set_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::Operation

Service producers can use this method to remove DNS record sets from private DNS zones in the shared producer host project.

Parameters:

  • parent (String)

    Required. 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.

  • remove_dns_record_set_request_object (Google::Apis::ServicenetworkingV1::RemoveDnsRecordSetRequest) (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:


580
581
582
583
584
585
586
587
588
589
590
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 580

def remove_dns_record_set(parent, remove_dns_record_set_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/dnsRecordSets:remove', options)
  command.request_representation = Google::Apis::ServicenetworkingV1::RemoveDnsRecordSetRequest::Representation
  command.request_object = remove_dns_record_set_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

#remove_dns_zone(parent, remove_dns_zone_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::Operation

Service producers can use this method to remove private DNS zones in the shared producer host project and matching peering zones in the consumer project.

Parameters:

  • parent (String)

    Required. 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.

  • remove_dns_zone_request_object (Google::Apis::ServicenetworkingV1::RemoveDnsZoneRequest) (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:


689
690
691
692
693
694
695
696
697
698
699
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 689

def remove_dns_zone(parent, remove_dns_zone_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/dnsZones:remove', options)
  command.request_representation = Google::Apis::ServicenetworkingV1::RemoveDnsZoneRequest::Representation
  command.request_object = remove_dns_zone_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

#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).

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::ServicenetworkingV1::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:


342
343
344
345
346
347
348
349
350
351
352
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 342

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', options)
  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

#update_dns_record_set(parent, update_dns_record_set_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicenetworkingV1::Operation

Service producers can use this method to update DNS record sets from private DNS zones in the shared producer host project.

Parameters:

  • parent (String)

    Required. 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.

  • update_dns_record_set_request_object (Google::Apis::ServicenetworkingV1::UpdateDnsRecordSetRequest) (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:


616
617
618
619
620
621
622
623
624
625
626
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 616

def update_dns_record_set(parent, update_dns_record_set_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/dnsRecordSets:update', options)
  command.request_representation = Google::Apis::ServicenetworkingV1::UpdateDnsRecordSetRequest::Representation
  command.request_object = update_dns_record_set_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 requested range are 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.

Parameters:

  • parent (String)

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

  • validate_consumer_config_request_object (Google::Apis::ServicenetworkingV1::ValidateConsumerConfigRequest) (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:


380
381
382
383
384
385
386
387
388
389
390
# File 'generated/google/apis/servicenetworking_v1/service.rb', line 380

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', options)
  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