lib/google/cloud/compute/v1/public_advertised_prefixes/rest/client.rb in google-cloud-compute-v1-2.5.0 vs lib/google/cloud/compute/v1/public_advertised_prefixes/rest/client.rb in google-cloud-compute-v1-2.6.0
- old
+ new
@@ -63,10 +63,12 @@
break parent_const.configure if parent_const.respond_to? :configure
namespace.pop
end
default_config = Client::Configuration.new parent_config
+ default_config.rpcs.announce.timeout = 600.0
+
default_config.rpcs.delete.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]
@@ -79,10 +81,12 @@
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
}
default_config.rpcs.patch.timeout = 600.0
+ default_config.rpcs.withdraw.timeout = 600.0
+
default_config
end
yield @configure if block_given?
@configure
end
@@ -162,10 +166,100 @@
attr_reader :global_operations
# Service calls
##
+ # Announces the specified PublicAdvertisedPrefix
+ #
+ # @overload announce(request, options = nil)
+ # Pass arguments to `announce` via a request object, either of type
+ # {::Google::Cloud::Compute::V1::AnnouncePublicAdvertisedPrefixeRequest} or an equivalent Hash.
+ #
+ # @param request [::Google::Cloud::Compute::V1::AnnouncePublicAdvertisedPrefixeRequest, ::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.
+ #
+ # @overload announce(project: nil, public_advertised_prefix: nil, request_id: nil)
+ # Pass arguments to `announce` 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 project [::String]
+ # Project ID for this request.
+ # @param public_advertised_prefix [::String]
+ # The name of the public advertised prefix. It should comply with RFC1035.
+ # @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, operation] Access the result along with the TransportOperation object
+ # @yieldparam result [::Gapic::GenericLRO::Operation]
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
+ #
+ # @return [::Gapic::GenericLRO::Operation]
+ #
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
+ #
+ # @example Basic example
+ # require "google/cloud/compute/v1"
+ #
+ # # Create a client object. The client can be reused for multiple calls.
+ # client = Google::Cloud::Compute::V1::PublicAdvertisedPrefixes::Rest::Client.new
+ #
+ # # Create a request. To set request fields, pass in keyword arguments.
+ # request = Google::Cloud::Compute::V1::AnnouncePublicAdvertisedPrefixeRequest.new
+ #
+ # # Call the announce method.
+ # result = client.announce request
+ #
+ # # The returned object is of type Google::Cloud::Compute::V1::Operation.
+ # p result
+ #
+ def announce request, options = nil
+ raise ::ArgumentError, "request must be provided" if request.nil?
+
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::AnnouncePublicAdvertisedPrefixeRequest
+
+ # 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.announce.metadata.to_h
+
+ # Set x-goog-api-client and x-goog-user-project headers
+ 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]
+
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+ options.apply_defaults timeout: @config.rpcs.announce.timeout,
+ metadata: call_metadata,
+ retry_policy: @config.rpcs.announce.retry_policy
+
+ options.apply_defaults timeout: @config.timeout,
+ metadata: @config.metadata,
+ retry_policy: @config.retry_policy
+
+ @public_advertised_prefixes_stub.announce request, options do |result, response|
+ result = ::Google::Cloud::Compute::V1::GlobalOperations::Rest::NonstandardLro.create_operation(
+ operation: result,
+ client: global_operations,
+ request_values: {
+ "project" => request.project
+ },
+ options: options
+ )
+ yield result, response if block_given?
+ return result
+ end
+ rescue ::Gapic::Rest::Error => e
+ raise ::Google::Cloud::Error.from_error(e)
+ end
+
+ ##
# Deletes the specified PublicAdvertisedPrefix
#
# @overload delete(request, options = nil)
# Pass arguments to `delete` via a request object, either of type
# {::Google::Cloud::Compute::V1::DeletePublicAdvertisedPrefixeRequest} or an equivalent Hash.
@@ -440,11 +534,11 @@
# 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. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` 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) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`.
+ # A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The 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`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` 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) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
# @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]
@@ -603,10 +697,100 @@
rescue ::Gapic::Rest::Error => e
raise ::Google::Cloud::Error.from_error(e)
end
##
+ # Withdraws the specified PublicAdvertisedPrefix
+ #
+ # @overload withdraw(request, options = nil)
+ # Pass arguments to `withdraw` via a request object, either of type
+ # {::Google::Cloud::Compute::V1::WithdrawPublicAdvertisedPrefixeRequest} or an equivalent Hash.
+ #
+ # @param request [::Google::Cloud::Compute::V1::WithdrawPublicAdvertisedPrefixeRequest, ::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.
+ #
+ # @overload withdraw(project: nil, public_advertised_prefix: nil, request_id: nil)
+ # Pass arguments to `withdraw` 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 project [::String]
+ # Project ID for this request.
+ # @param public_advertised_prefix [::String]
+ # The name of the public advertised prefix. It should comply with RFC1035.
+ # @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, operation] Access the result along with the TransportOperation object
+ # @yieldparam result [::Gapic::GenericLRO::Operation]
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
+ #
+ # @return [::Gapic::GenericLRO::Operation]
+ #
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
+ #
+ # @example Basic example
+ # require "google/cloud/compute/v1"
+ #
+ # # Create a client object. The client can be reused for multiple calls.
+ # client = Google::Cloud::Compute::V1::PublicAdvertisedPrefixes::Rest::Client.new
+ #
+ # # Create a request. To set request fields, pass in keyword arguments.
+ # request = Google::Cloud::Compute::V1::WithdrawPublicAdvertisedPrefixeRequest.new
+ #
+ # # Call the withdraw method.
+ # result = client.withdraw request
+ #
+ # # The returned object is of type Google::Cloud::Compute::V1::Operation.
+ # p result
+ #
+ def withdraw request, options = nil
+ raise ::ArgumentError, "request must be provided" if request.nil?
+
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Compute::V1::WithdrawPublicAdvertisedPrefixeRequest
+
+ # 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.withdraw.metadata.to_h
+
+ # Set x-goog-api-client and x-goog-user-project headers
+ 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]
+
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+ options.apply_defaults timeout: @config.rpcs.withdraw.timeout,
+ metadata: call_metadata,
+ retry_policy: @config.rpcs.withdraw.retry_policy
+
+ options.apply_defaults timeout: @config.timeout,
+ metadata: @config.metadata,
+ retry_policy: @config.retry_policy
+
+ @public_advertised_prefixes_stub.withdraw request, options do |result, response|
+ result = ::Google::Cloud::Compute::V1::GlobalOperations::Rest::NonstandardLro.create_operation(
+ operation: result,
+ client: global_operations,
+ request_values: {
+ "project" => request.project
+ },
+ options: options
+ )
+ yield result, response if block_given?
+ return result
+ end
+ rescue ::Gapic::Rest::Error => e
+ raise ::Google::Cloud::Error.from_error(e)
+ end
+
+ ##
# Configuration class for the PublicAdvertisedPrefixes REST API.
#
# This class represents the configuration for PublicAdvertisedPrefixes REST,
# providing control over timeouts, retry behavior, logging, transport
# parameters, and other low-level controls. Certain parameters can also be
@@ -618,21 +802,21 @@
# on construction.
#
# @example
#
# # Modify the global config, setting the timeout for
- # # delete to 20 seconds,
+ # # announce to 20 seconds,
# # and all remaining timeouts to 10 seconds.
# ::Google::Cloud::Compute::V1::PublicAdvertisedPrefixes::Rest::Client.configure do |config|
# config.timeout = 10.0
- # config.rpcs.delete.timeout = 20.0
+ # config.rpcs.announce.timeout = 20.0
# end
#
# # Apply the above configuration only to a new client.
# client = ::Google::Cloud::Compute::V1::PublicAdvertisedPrefixes::Rest::Client.new do |config|
# config.timeout = 10.0
- # config.rpcs.delete.timeout = 20.0
+ # config.rpcs.announce.timeout = 20.0
# end
#
# @!attribute [rw] endpoint
# The hostname or hostname:port of the service endpoint.
# Defaults to `"compute.googleapis.com"`.
@@ -728,10 +912,15 @@
# * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
# trigger a retry.
#
class Rpcs
##
+ # RPC-specific configuration for `announce`
+ # @return [::Gapic::Config::Method]
+ #
+ attr_reader :announce
+ ##
# RPC-specific configuration for `delete`
# @return [::Gapic::Config::Method]
#
attr_reader :delete
##
@@ -752,22 +941,31 @@
##
# RPC-specific configuration for `patch`
# @return [::Gapic::Config::Method]
#
attr_reader :patch
+ ##
+ # RPC-specific configuration for `withdraw`
+ # @return [::Gapic::Config::Method]
+ #
+ attr_reader :withdraw
# @private
def initialize parent_rpcs = nil
+ announce_config = parent_rpcs.announce if parent_rpcs.respond_to? :announce
+ @announce = ::Gapic::Config::Method.new announce_config
delete_config = parent_rpcs.delete if parent_rpcs.respond_to? :delete
@delete = ::Gapic::Config::Method.new delete_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
patch_config = parent_rpcs.patch if parent_rpcs.respond_to? :patch
@patch = ::Gapic::Config::Method.new patch_config
+ withdraw_config = parent_rpcs.withdraw if parent_rpcs.respond_to? :withdraw
+ @withdraw = ::Gapic::Config::Method.new withdraw_config
yield self if block_given?
end
end
end