REST client for the Firewalls service.
The Firewalls API.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the Firewalls Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all Firewalls clients ::Google::Cloud::Compute::V1::Firewalls::Rest::Client.configure do |config| config.timeout = 10.0 end
#configure
def configure() { |config| ... } -> Client::Configuration
Configure the Firewalls 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 Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
#delete
def delete(request, options = nil) -> ::Gapic::Rest::BaseOperation
def delete(firewall: nil, project: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
Deletes the specified firewall.
def delete(request, options = nil) -> ::Gapic::Rest::BaseOperation
delete
via a request object, either of type
DeleteFirewallRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::DeleteFirewallRequest, ::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.
- 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
def delete(firewall: nil, project: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
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).
- firewall (::String) — Name of the firewall rule to delete.
- project (::String) — Project ID for this request.
- 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).
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::Rest::BaseOperation)
- response (::Faraday::Response)
- (::Gapic::Rest::BaseOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#get
def get(request, options = nil) -> ::Google::Cloud::Compute::V1::Firewall
def get(firewall: nil, project: nil) -> ::Google::Cloud::Compute::V1::Firewall
Returns the specified firewall.
def get(request, options = nil) -> ::Google::Cloud::Compute::V1::Firewall
get
via a request object, either of type
GetFirewallRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::GetFirewallRequest, ::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.
- 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
def get(firewall: nil, project: nil) -> ::Google::Cloud::Compute::V1::Firewall
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).
- firewall (::String) — Name of the firewall rule to return.
- project (::String) — Project ID for this request.
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::Firewall)
- response (::Faraday::Response)
- (::Google::Cloud::Error) — if the REST call is aborted.
#initialize
def initialize() { |config| ... } -> Client
Create a new Firewalls REST client object.
- (config) — Configure the Firewalls client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::Compute::V1::Firewalls::Rest::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Compute::V1::Firewalls::Rest::Client.new do |config| config.timeout = 10.0 end
#insert
def insert(request, options = nil) -> ::Gapic::Rest::BaseOperation
def insert(firewall_resource: nil, project: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
Creates a firewall rule in the specified project using the data included in the request.
def insert(request, options = nil) -> ::Gapic::Rest::BaseOperation
insert
via a request object, either of type
InsertFirewallRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::InsertFirewallRequest, ::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.
- 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
def insert(firewall_resource: nil, project: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
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).
- firewall_resource (::Google::Cloud::Compute::V1::Firewall, ::Hash) — The body resource for this request
- project (::String) — Project ID for this request.
- 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).
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::Rest::BaseOperation)
- response (::Faraday::Response)
- (::Gapic::Rest::BaseOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#list
def list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Firewall>
def list(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Firewall>
Retrieves the list of firewall rules available to the specified project.
def list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Firewall>
list
via a request object, either of type
ListFirewallsRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::ListFirewallsRequest, ::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.
- 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
def list(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Firewall>
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).
-
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 namedexample-instance
by specifyingname != example-instance
. You can also filter nested fields. For example, you could specifyscheduling.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 anAND
expression. However, you can includeAND
andOR
expressions explicitly. For example:(cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)
-
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 anextPageToken
that can be used to get the next page of results in subsequent list requests. Acceptable values are0
to500
, inclusive. (Default:500
) -
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 thecreationTimestamp
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 byname
orcreationTimestamp desc
is supported. -
page_token (::String) — Specifies a page token to use. Set
pageToken
to thenextPageToken
returned by a previous list request to get the next page of results. - project (::String) — Project ID for this request.
- return_partial_success (::Boolean) — Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Firewall>)
- response (::Faraday::Response)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Firewall>)
- (::Google::Cloud::Error) — if the REST call is aborted.
#patch
def patch(request, options = nil) -> ::Gapic::Rest::BaseOperation
def patch(firewall: nil, firewall_resource: nil, project: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.
def patch(request, options = nil) -> ::Gapic::Rest::BaseOperation
patch
via a request object, either of type
PatchFirewallRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::PatchFirewallRequest, ::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.
- 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
def patch(firewall: nil, firewall_resource: nil, project: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
patch
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).
- firewall (::String) — Name of the firewall rule to patch.
- firewall_resource (::Google::Cloud::Compute::V1::Firewall, ::Hash) — The body resource for this request
- project (::String) — Project ID for this request.
- 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).
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::Rest::BaseOperation)
- response (::Faraday::Response)
- (::Gapic::Rest::BaseOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#update
def update(request, options = nil) -> ::Gapic::Rest::BaseOperation
def update(firewall: nil, firewall_resource: nil, project: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead.
def update(request, options = nil) -> ::Gapic::Rest::BaseOperation
update
via a request object, either of type
UpdateFirewallRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::UpdateFirewallRequest, ::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.
- 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
def update(firewall: nil, firewall_resource: nil, project: nil, request_id: nil) -> ::Gapic::Rest::BaseOperation
update
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).
- firewall (::String) — Name of the firewall rule to update.
- firewall_resource (::Google::Cloud::Compute::V1::Firewall, ::Hash) — The body resource for this request
- project (::String) — Project ID for this request.
- 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).
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::Rest::BaseOperation)
- response (::Faraday::Response)
- (::Gapic::Rest::BaseOperation)
- (::Google::Cloud::Error) — if the REST call is aborted.