# frozen_string_literal: true # Copyright 2021 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # https://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # Auto-generated by gapic-generator-ruby. DO NOT EDIT! require "google/cloud/errors" require "google/cloud/compute/v1/compute_pb" require "google/cloud/compute/v1/global_network_endpoint_groups/rest/service_stub" module Google module Cloud module Compute module V1 module GlobalNetworkEndpointGroups module Rest ## # REST client for the GlobalNetworkEndpointGroups service. # # The GlobalNetworkEndpointGroups API. # class Client # @private attr_reader :global_network_endpoint_groups_stub ## # Configure the GlobalNetworkEndpointGroups Client class. # # See {::Google::Cloud::Compute::V1::GlobalNetworkEndpointGroups::Rest::Client::Configuration} # for a description of the configuration fields. # # @example # # # Modify the configuration for all GlobalNetworkEndpointGroups clients # ::Google::Cloud::Compute::V1::GlobalNetworkEndpointGroups::Rest::Client.configure do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # # @return [Client::Configuration] # def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Compute", "V1"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.rpcs.attach_network_endpoints.timeout = 600.0 default_config.rpcs.delete.timeout = 600.0 default_config.rpcs.detach_network_endpoints.timeout = 600.0 default_config.rpcs.get.timeout = 600.0 default_config.rpcs.get.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.insert.timeout = 600.0 default_config.rpcs.list.timeout = 600.0 default_config.rpcs.list.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14] } default_config.rpcs.list_network_endpoints.timeout = 600.0 default_config end yield @configure if block_given? @configure end ## # Configure the GlobalNetworkEndpointGroups Client instance. # # The configuration is set to the derived mode, meaning that values can be changed, # but structural changes (adding new fields, etc.) are not allowed. Structural changes # should be made on {Client.configure}. # # See {::Google::Cloud::Compute::V1::GlobalNetworkEndpointGroups::Rest::Client::Configuration} # for a description of the configuration fields. # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # # @return [Client::Configuration] # def configure yield @config if block_given? @config end ## # Create a new GlobalNetworkEndpointGroups REST client object. # # @example # # # Create a client using the default configuration # client = ::Google::Cloud::Compute::V1::GlobalNetworkEndpointGroups::Rest::Client.new # # # Create a client using a custom configuration # client = ::Google::Cloud::Compute::V1::GlobalNetworkEndpointGroups::Rest::Client.new do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the GlobalNetworkEndpointGroups client. # @yieldparam config [Client::Configuration] # def initialize # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials credentials ||= Credentials.default scope: @config.scope if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @global_network_endpoint_groups_stub = ::Google::Cloud::Compute::V1::GlobalNetworkEndpointGroups::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials end # Service calls ## # Attach a network endpoint to the specified network endpoint group. # # @overload attach_network_endpoints(request, options = nil) # Pass arguments to `attach_network_endpoints` via a request object, either of type # {::Google::Cloud::Compute::V1::AttachNetworkEndpointsGlobalNetworkEndpointGroupRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Compute::V1::AttachNetworkEndpointsGlobalNetworkEndpointGroupRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # Note: currently retry functionality is not implemented. While it is possible # to set it using ::Gapic::CallOptions, it will not be applied # # @overload attach_network_endpoints(global_network_endpoint_groups_attach_endpoints_request_resource: nil, network_endpoint_group: nil, project: nil, request_id: nil) # Pass arguments to `attach_network_endpoints` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param global_network_endpoint_groups_attach_endpoints_request_resource [::Google::Cloud::Compute::V1::GlobalNetworkEndpointGroupsAttachEndpointsRequest, ::Hash] # The body resource for this request # @param network_endpoint_group [::String] # The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035. # @param project [::String] # Project ID for this request. # @param request_id [::String] # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). # @yield [result, response] Access the result along with the Faraday response object # @yieldparam result [::Gapic::Rest::BaseOperation] # @yieldparam response [::Faraday::Response] # # @return [::Gapic::Rest::BaseOperation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def attach_network_endpoints request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::AttachNetworkEndpointsGlobalNetworkEndpointGroupRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.attach_network_endpoints.metadata.to_h # Set x-goog-api-client header call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] options.apply_defaults timeout: @config.rpcs.attach_network_endpoints.timeout, metadata: call_metadata options.apply_defaults timeout: @config.timeout, metadata: @config.metadata @global_network_endpoint_groups_stub.attach_network_endpoints request, options do |result, response| result = ::Gapic::Rest::BaseOperation.new result yield result, response if block_given? return result end rescue ::Faraday::Error => e gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e raise ::Google::Cloud::Error.from_error(gapic_error) end ## # Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it. # # @overload delete(request, options = nil) # Pass arguments to `delete` via a request object, either of type # {::Google::Cloud::Compute::V1::DeleteGlobalNetworkEndpointGroupRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Compute::V1::DeleteGlobalNetworkEndpointGroupRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # Note: currently retry functionality is not implemented. While it is possible # to set it using ::Gapic::CallOptions, it will not be applied # # @overload delete(network_endpoint_group: nil, project: nil, request_id: nil) # Pass arguments to `delete` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param network_endpoint_group [::String] # The name of the network endpoint group to delete. It should comply with RFC1035. # @param project [::String] # Project ID for this request. # @param request_id [::String] # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). # @yield [result, response] Access the result along with the Faraday response object # @yieldparam result [::Gapic::Rest::BaseOperation] # @yieldparam response [::Faraday::Response] # # @return [::Gapic::Rest::BaseOperation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def delete request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::DeleteGlobalNetworkEndpointGroupRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.delete.metadata.to_h # Set x-goog-api-client header call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] options.apply_defaults timeout: @config.rpcs.delete.timeout, metadata: call_metadata options.apply_defaults timeout: @config.timeout, metadata: @config.metadata @global_network_endpoint_groups_stub.delete request, options do |result, response| result = ::Gapic::Rest::BaseOperation.new result yield result, response if block_given? return result end rescue ::Faraday::Error => e gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e raise ::Google::Cloud::Error.from_error(gapic_error) end ## # Detach the network endpoint from the specified network endpoint group. # # @overload detach_network_endpoints(request, options = nil) # Pass arguments to `detach_network_endpoints` via a request object, either of type # {::Google::Cloud::Compute::V1::DetachNetworkEndpointsGlobalNetworkEndpointGroupRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Compute::V1::DetachNetworkEndpointsGlobalNetworkEndpointGroupRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # Note: currently retry functionality is not implemented. While it is possible # to set it using ::Gapic::CallOptions, it will not be applied # # @overload detach_network_endpoints(global_network_endpoint_groups_detach_endpoints_request_resource: nil, network_endpoint_group: nil, project: nil, request_id: nil) # Pass arguments to `detach_network_endpoints` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param global_network_endpoint_groups_detach_endpoints_request_resource [::Google::Cloud::Compute::V1::GlobalNetworkEndpointGroupsDetachEndpointsRequest, ::Hash] # The body resource for this request # @param network_endpoint_group [::String] # The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035. # @param project [::String] # Project ID for this request. # @param request_id [::String] # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). # @yield [result, response] Access the result along with the Faraday response object # @yieldparam result [::Gapic::Rest::BaseOperation] # @yieldparam response [::Faraday::Response] # # @return [::Gapic::Rest::BaseOperation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def detach_network_endpoints request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::DetachNetworkEndpointsGlobalNetworkEndpointGroupRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.detach_network_endpoints.metadata.to_h # Set x-goog-api-client header call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] options.apply_defaults timeout: @config.rpcs.detach_network_endpoints.timeout, metadata: call_metadata options.apply_defaults timeout: @config.timeout, metadata: @config.metadata @global_network_endpoint_groups_stub.detach_network_endpoints request, options do |result, response| result = ::Gapic::Rest::BaseOperation.new result yield result, response if block_given? return result end rescue ::Faraday::Error => e gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e raise ::Google::Cloud::Error.from_error(gapic_error) end ## # Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request. # # @overload get(request, options = nil) # Pass arguments to `get` via a request object, either of type # {::Google::Cloud::Compute::V1::GetGlobalNetworkEndpointGroupRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Compute::V1::GetGlobalNetworkEndpointGroupRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # Note: currently retry functionality is not implemented. While it is possible # to set it using ::Gapic::CallOptions, it will not be applied # # @overload get(network_endpoint_group: nil, project: nil) # Pass arguments to `get` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param network_endpoint_group [::String] # The name of the network endpoint group. It should comply with RFC1035. # @param project [::String] # Project ID for this request. # @yield [result, response] Access the result along with the Faraday response object # @yieldparam result [::Google::Cloud::Compute::V1::NetworkEndpointGroup] # @yieldparam response [::Faraday::Response] # # @return [::Google::Cloud::Compute::V1::NetworkEndpointGroup] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def get request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::GetGlobalNetworkEndpointGroupRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.get.metadata.to_h # Set x-goog-api-client header call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] options.apply_defaults timeout: @config.rpcs.get.timeout, metadata: call_metadata options.apply_defaults timeout: @config.timeout, metadata: @config.metadata @global_network_endpoint_groups_stub.get request, options do |result, response| yield result, response if block_given? return result end rescue ::Faraday::Error => e gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e raise ::Google::Cloud::Error.from_error(gapic_error) end ## # Creates a network endpoint group in the specified project using the parameters that are included in the request. # # @overload insert(request, options = nil) # Pass arguments to `insert` via a request object, either of type # {::Google::Cloud::Compute::V1::InsertGlobalNetworkEndpointGroupRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Compute::V1::InsertGlobalNetworkEndpointGroupRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # Note: currently retry functionality is not implemented. While it is possible # to set it using ::Gapic::CallOptions, it will not be applied # # @overload insert(network_endpoint_group_resource: nil, project: nil, request_id: nil) # Pass arguments to `insert` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param network_endpoint_group_resource [::Google::Cloud::Compute::V1::NetworkEndpointGroup, ::Hash] # The body resource for this request # @param project [::String] # Project ID for this request. # @param request_id [::String] # An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). # @yield [result, response] Access the result along with the Faraday response object # @yieldparam result [::Gapic::Rest::BaseOperation] # @yieldparam response [::Faraday::Response] # # @return [::Gapic::Rest::BaseOperation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def insert request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::InsertGlobalNetworkEndpointGroupRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.insert.metadata.to_h # Set x-goog-api-client header call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] options.apply_defaults timeout: @config.rpcs.insert.timeout, metadata: call_metadata options.apply_defaults timeout: @config.timeout, metadata: @config.metadata @global_network_endpoint_groups_stub.insert request, options do |result, response| result = ::Gapic::Rest::BaseOperation.new result yield result, response if block_given? return result end rescue ::Faraday::Error => e gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e raise ::Google::Cloud::Error.from_error(gapic_error) end ## # Retrieves the list of network endpoint groups that are located in the specified project. # # @overload list(request, options = nil) # Pass arguments to `list` via a request object, either of type # {::Google::Cloud::Compute::V1::ListGlobalNetworkEndpointGroupsRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Compute::V1::ListGlobalNetworkEndpointGroupsRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # Note: currently retry functionality is not implemented. While it is possible # to set it using ::Gapic::CallOptions, it will not be applied # # @overload list(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) # Pass arguments to `list` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param filter [::String] # A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` # @param max_results [::Integer] # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param order_by [::String] # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param page_token [::String] # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. # @param project [::String] # Project ID for this request. # @param return_partial_success [::Boolean] # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. # @yield [result, response] Access the result along with the Faraday response object # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::NetworkEndpointGroup>] # @yieldparam response [::Faraday::Response] # # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::NetworkEndpointGroup>] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def list request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::ListGlobalNetworkEndpointGroupsRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.list.metadata.to_h # Set x-goog-api-client header call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] options.apply_defaults timeout: @config.rpcs.list.timeout, metadata: call_metadata options.apply_defaults timeout: @config.timeout, metadata: @config.metadata @global_network_endpoint_groups_stub.list request, options do |result, response| result = ::Gapic::Rest::PagedEnumerable.new @global_network_endpoint_groups_stub, :list, "items", request, result, options yield result, response if block_given? return result end rescue ::Faraday::Error => e gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e raise ::Google::Cloud::Error.from_error(gapic_error) end ## # Lists the network endpoints in the specified network endpoint group. # # @overload list_network_endpoints(request, options = nil) # Pass arguments to `list_network_endpoints` via a request object, either of type # {::Google::Cloud::Compute::V1::ListNetworkEndpointsGlobalNetworkEndpointGroupsRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Compute::V1::ListNetworkEndpointsGlobalNetworkEndpointGroupsRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. # Note: currently retry functionality is not implemented. While it is possible # to set it using ::Gapic::CallOptions, it will not be applied # # @overload list_network_endpoints(filter: nil, max_results: nil, network_endpoint_group: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) # Pass arguments to `list_network_endpoints` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param filter [::String] # A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` # @param max_results [::Integer] # The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) # @param network_endpoint_group [::String] # The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035. # @param order_by [::String] # Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. # @param page_token [::String] # Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. # @param project [::String] # Project ID for this request. # @param return_partial_success [::Boolean] # Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. # @yield [result, response] Access the result along with the Faraday response object # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::NetworkEndpointWithHealthStatus>] # @yieldparam response [::Faraday::Response] # # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::NetworkEndpointWithHealthStatus>] # # @raise [::Google::Cloud::Error] if the REST call is aborted. def list_network_endpoints request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::ListNetworkEndpointsGlobalNetworkEndpointGroupsRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.list_network_endpoints.metadata.to_h # Set x-goog-api-client header call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] options.apply_defaults timeout: @config.rpcs.list_network_endpoints.timeout, metadata: call_metadata options.apply_defaults timeout: @config.timeout, metadata: @config.metadata @global_network_endpoint_groups_stub.list_network_endpoints request, options do |result, response| result = ::Gapic::Rest::PagedEnumerable.new @global_network_endpoint_groups_stub, :list_network_endpoints, "items", request, result, options yield result, response if block_given? return result end rescue ::Faraday::Error => e gapic_error = ::Gapic::Rest::Error.wrap_faraday_error e raise ::Google::Cloud::Error.from_error(gapic_error) end ## # Configuration class for the GlobalNetworkEndpointGroups REST API. # # This class represents the configuration for GlobalNetworkEndpointGroups REST, # providing control over credentials, timeouts, retry behavior, logging. # # Configuration can be applied globally to all clients, or to a single client # on construction. # # # Examples # # To modify the global config, setting the timeout for all calls to 10 seconds: # # ::Google::Cloud::Compute::V1::GlobalNetworkEndpointGroups::Client.configure do |config| # config.timeout = 10.0 # end # # To apply the above configuration only to a new client: # # client = ::Google::Cloud::Compute::V1::GlobalNetworkEndpointGroups::Client.new do |config| # config.timeout = 10.0 # end # # @!attribute [rw] endpoint # The hostname or hostname:port of the service endpoint. # Defaults to `"compute.googleapis.com"`. # @return [::String] # @!attribute [rw] credentials # Credentials to send with calls. You may provide any of the following types: # * (`String`) The path to a service account key file in JSON format # * (`Hash`) A service account key as a Hash # * (`Google::Auth::Credentials`) A googleauth credentials object # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html)) # * (`Signet::OAuth2::Client`) A signet oauth2 client object # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html)) # * (`nil`) indicating no credentials # @return [::Object] # @!attribute [rw] scope # The OAuth scopes # @return [::Array<::String>] # @!attribute [rw] lib_name # The library name as recorded in instrumentation and logging # @return [::String] # @!attribute [rw] lib_version # The library version as recorded in instrumentation and logging # @return [::String] # @!attribute [rw] timeout # The call timeout in seconds. # @return [::Numeric] # @!attribute [rw] metadata # Additional REST headers to be sent with the call. # @return [::Hash{::Symbol=>::String}] # class Configuration extend ::Gapic::Config config_attr :endpoint, "compute.googleapis.com", ::String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed.any? { |klass| klass === value } end config_attr :scope, nil, ::String, ::Array, nil config_attr :lib_name, nil, ::String, nil config_attr :lib_version, nil, ::String, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil # @private def initialize parent_config = nil @parent_config = parent_config unless parent_config.nil? yield self if block_given? end ## # Configurations for individual RPCs # @return [Rpcs] # def rpcs @rpcs ||= begin parent_rpcs = nil parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs) Rpcs.new parent_rpcs end end ## # Configuration RPC class for the GlobalNetworkEndpointGroups API. # # Includes fields providing the configuration for each RPC in this service. # Each configuration object is of type `Gapic::Config::Method` and includes # the following configuration fields: # # * `timeout` (*type:* `Numeric`) - The call timeout in seconds # # there is one other field (`retry_policy`) that can be set # but is currently not supported for REST Gapic libraries. # class Rpcs ## # RPC-specific configuration for `attach_network_endpoints` # @return [::Gapic::Config::Method] # attr_reader :attach_network_endpoints ## # RPC-specific configuration for `delete` # @return [::Gapic::Config::Method] # attr_reader :delete ## # RPC-specific configuration for `detach_network_endpoints` # @return [::Gapic::Config::Method] # attr_reader :detach_network_endpoints ## # RPC-specific configuration for `get` # @return [::Gapic::Config::Method] # attr_reader :get ## # RPC-specific configuration for `insert` # @return [::Gapic::Config::Method] # attr_reader :insert ## # RPC-specific configuration for `list` # @return [::Gapic::Config::Method] # attr_reader :list ## # RPC-specific configuration for `list_network_endpoints` # @return [::Gapic::Config::Method] # attr_reader :list_network_endpoints # @private def initialize parent_rpcs = nil attach_network_endpoints_config = parent_rpcs.attach_network_endpoints if parent_rpcs.respond_to? :attach_network_endpoints @attach_network_endpoints = ::Gapic::Config::Method.new attach_network_endpoints_config delete_config = parent_rpcs.delete if parent_rpcs.respond_to? :delete @delete = ::Gapic::Config::Method.new delete_config detach_network_endpoints_config = parent_rpcs.detach_network_endpoints if parent_rpcs.respond_to? :detach_network_endpoints @detach_network_endpoints = ::Gapic::Config::Method.new detach_network_endpoints_config get_config = parent_rpcs.get if parent_rpcs.respond_to? :get @get = ::Gapic::Config::Method.new get_config insert_config = parent_rpcs.insert if parent_rpcs.respond_to? :insert @insert = ::Gapic::Config::Method.new insert_config list_config = parent_rpcs.list if parent_rpcs.respond_to? :list @list = ::Gapic::Config::Method.new list_config list_network_endpoints_config = parent_rpcs.list_network_endpoints if parent_rpcs.respond_to? :list_network_endpoints @list_network_endpoints = ::Gapic::Config::Method.new list_network_endpoints_config yield self if block_given? end end end end end end end end end end