Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::Subnetworks::Rest::Client.
REST client for the Subnetworks service.
The Subnetworks API.
Inherits
- Object
Methods
.configure
def self.configure() { |config| ... } -> Client::Configuration
Configure the Subnetworks Client class.
See Configuration for a description of the configuration fields.
- (config) — Configure the Client client.
- config (Client::Configuration)
# Modify the configuration for all Subnetworks clients ::Google::Cloud::Compute::V1::Subnetworks::Rest::Client.configure do |config| config.timeout = 10.0 end
#aggregated_list
def aggregated_list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::SubnetworksScopedList>
def aggregated_list(filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::SubnetworksScopedList>
Retrieves an aggregated list of subnetworks.
def aggregated_list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::SubnetworksScopedList>
aggregated_list
via a request object, either of type
AggregatedListSubnetworksRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::AggregatedListSubnetworksRequest, ::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 aggregated_list(filter: nil, include_all_scopes: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::SubnetworksScopedList>
aggregated_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. 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 namedexample-instance
by specifyingname != 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 withowner
label use:labels.owner:*
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)
If you want to use a regular expression, use theeq
(equal) orne
(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 usename ne .*instance
. - include_all_scopes (::Boolean) — Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
-
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<::String, ::Google::Cloud::Compute::V1::SubnetworksScopedList>)
- response (::Faraday::Response)
- (::Gapic::Rest::PagedEnumerable<::String, ::Google::Cloud::Compute::V1::SubnetworksScopedList>)
- (::Google::Cloud::Error) — if the REST call is aborted.
#configure
def configure() { |config| ... } -> Client::Configuration
Configure the Subnetworks 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::GenericLRO::Operation
def delete(project: nil, region: nil, request_id: nil, subnetwork: nil) -> ::Gapic::GenericLRO::Operation
Deletes the specified subnetwork.
def delete(request, options = nil) -> ::Gapic::GenericLRO::Operation
delete
via a request object, either of type
DeleteSubnetworkRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::DeleteSubnetworkRequest, ::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(project: nil, region: nil, request_id: nil, subnetwork: nil) -> ::Gapic::GenericLRO::Operation
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).
- project (::String) — Project ID for this request.
- region (::String) — Name of the region scoping 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).
- subnetwork (::String) — Name of the Subnetwork resource to delete.
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#expand_ip_cidr_range
def expand_ip_cidr_range(request, options = nil) -> ::Gapic::GenericLRO::Operation
def expand_ip_cidr_range(project: nil, region: nil, request_id: nil, subnetwork: nil, subnetworks_expand_ip_cidr_range_request_resource: nil) -> ::Gapic::GenericLRO::Operation
Expands the IP CIDR range of the subnetwork to a specified value.
def expand_ip_cidr_range(request, options = nil) -> ::Gapic::GenericLRO::Operation
expand_ip_cidr_range
via a request object, either of type
ExpandIpCidrRangeSubnetworkRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::ExpandIpCidrRangeSubnetworkRequest, ::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 expand_ip_cidr_range(project: nil, region: nil, request_id: nil, subnetwork: nil, subnetworks_expand_ip_cidr_range_request_resource: nil) -> ::Gapic::GenericLRO::Operation
expand_ip_cidr_range
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).
- project (::String) — Project ID for this request.
- region (::String) — Name of the region scoping 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).
- subnetwork (::String) — Name of the Subnetwork resource to update.
- subnetworks_expand_ip_cidr_range_request_resource (::Google::Cloud::Compute::V1::SubnetworksExpandIpCidrRangeRequest, ::Hash) — The body resource for this request
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#get
def get(request, options = nil) -> ::Google::Cloud::Compute::V1::Subnetwork
def get(project: nil, region: nil, subnetwork: nil) -> ::Google::Cloud::Compute::V1::Subnetwork
Returns the specified subnetwork. Gets a list of available subnetworks list() request.
def get(request, options = nil) -> ::Google::Cloud::Compute::V1::Subnetwork
get
via a request object, either of type
GetSubnetworkRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::GetSubnetworkRequest, ::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(project: nil, region: nil, subnetwork: nil) -> ::Google::Cloud::Compute::V1::Subnetwork
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).
- project (::String) — Project ID for this request.
- region (::String) — Name of the region scoping this request.
- subnetwork (::String) — Name of the Subnetwork resource to return.
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::Subnetwork)
- response (::Faraday::Response)
- (::Google::Cloud::Error) — if the REST call is aborted.
#get_iam_policy
def get_iam_policy(request, options = nil) -> ::Google::Cloud::Compute::V1::Policy
def get_iam_policy(options_requested_policy_version: nil, project: nil, region: nil, resource: nil) -> ::Google::Cloud::Compute::V1::Policy
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
def get_iam_policy(request, options = nil) -> ::Google::Cloud::Compute::V1::Policy
get_iam_policy
via a request object, either of type
GetIamPolicySubnetworkRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::GetIamPolicySubnetworkRequest, ::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_iam_policy(options_requested_policy_version: nil, project: nil, region: nil, resource: nil) -> ::Google::Cloud::Compute::V1::Policy
get_iam_policy
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).
- options_requested_policy_version (::Integer) — Requested IAM Policy version.
- project (::String) — Project ID for this request.
- region (::String) — The name of the region for this request.
- resource (::String) — Name or id of the resource for this request.
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::Policy)
- response (::Faraday::Response)
- (::Google::Cloud::Error) — if the REST call is aborted.
#initialize
def initialize() { |config| ... } -> Client
Create a new Subnetworks REST client object.
- (config) — Configure the Subnetworks client.
- config (Client::Configuration)
- (Client) — a new instance of Client
# Create a client using the default configuration client = ::Google::Cloud::Compute::V1::Subnetworks::Rest::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Compute::V1::Subnetworks::Rest::Client.new do |config| config.timeout = 10.0 end
#insert
def insert(request, options = nil) -> ::Gapic::GenericLRO::Operation
def insert(project: nil, region: nil, request_id: nil, subnetwork_resource: nil) -> ::Gapic::GenericLRO::Operation
Creates a subnetwork in the specified project using the data included in the request.
def insert(request, options = nil) -> ::Gapic::GenericLRO::Operation
insert
via a request object, either of type
InsertSubnetworkRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::InsertSubnetworkRequest, ::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(project: nil, region: nil, request_id: nil, subnetwork_resource: nil) -> ::Gapic::GenericLRO::Operation
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).
- project (::String) — Project ID for this request.
- region (::String) — Name of the region scoping 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).
- subnetwork_resource (::Google::Cloud::Compute::V1::Subnetwork, ::Hash) — The body resource for this request
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#list
def list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Subnetwork>
def list(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, region: nil, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Subnetwork>
Retrieves a list of subnetworks available to the specified project.
def list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Subnetwork>
list
via a request object, either of type
ListSubnetworksRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::ListSubnetworksRequest, ::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, region: nil, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Subnetwork>
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. 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 namedexample-instance
by specifyingname != 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 withowner
label use:labels.owner:*
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)
If you want to use a regular expression, use theeq
(equal) orne
(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 usename ne .*instance
. -
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.
- region (::String) — Name of the region scoping 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::Subnetwork>)
- response (::Faraday::Response)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::Subnetwork>)
- (::Google::Cloud::Error) — if the REST call is aborted.
#list_usable
def list_usable(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::UsableSubnetwork>
def list_usable(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::UsableSubnetwork>
Retrieves an aggregated list of all usable subnetworks in the project.
def list_usable(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::UsableSubnetwork>
list_usable
via a request object, either of type
ListUsableSubnetworksRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::ListUsableSubnetworksRequest, ::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_usable(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::UsableSubnetwork>
list_usable
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. 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 namedexample-instance
by specifyingname != 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 withowner
label use:labels.owner:*
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)
If you want to use a regular expression, use theeq
(equal) orne
(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 usename ne .*instance
. -
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::UsableSubnetwork>)
- response (::Faraday::Response)
- (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::UsableSubnetwork>)
- (::Google::Cloud::Error) — if the REST call is aborted.
#patch
def patch(request, options = nil) -> ::Gapic::GenericLRO::Operation
def patch(drain_timeout_seconds: nil, project: nil, region: nil, request_id: nil, subnetwork: nil, subnetwork_resource: nil) -> ::Gapic::GenericLRO::Operation
Patches the specified subnetwork with the data included in the request. Only certain fields can be updated with a patch request as indicated in the field descriptions. You must specify the current fingerprint of the subnetwork resource being patched.
def patch(request, options = nil) -> ::Gapic::GenericLRO::Operation
patch
via a request object, either of type
PatchSubnetworkRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::PatchSubnetworkRequest, ::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(drain_timeout_seconds: nil, project: nil, region: nil, request_id: nil, subnetwork: nil, subnetwork_resource: nil) -> ::Gapic::GenericLRO::Operation
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).
- drain_timeout_seconds (::Integer) — The drain timeout specifies the upper bound in seconds on the amount of time allowed to drain connections from the current ACTIVE subnetwork to the current BACKUP subnetwork. The drain timeout is only applicable when the following conditions are true: - the subnetwork being patched has purpose = INTERNAL_HTTPS_LOAD_BALANCER - the subnetwork being patched has role = BACKUP - the patch request is setting the role to ACTIVE. Note that after this patch operation the roles of the ACTIVE and BACKUP subnetworks will be swapped.
- project (::String) — Project ID for this request.
- region (::String) — Name of the region scoping 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).
- subnetwork (::String) — Name of the Subnetwork resource to patch.
- subnetwork_resource (::Google::Cloud::Compute::V1::Subnetwork, ::Hash) — The body resource for this request
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#region_operations
def region_operations() -> ::Google::Cloud::Compute::V1::RegionOperations::Rest::Client
Get the associated client for long-running operations via RegionOperations.
#set_iam_policy
def set_iam_policy(request, options = nil) -> ::Google::Cloud::Compute::V1::Policy
def set_iam_policy(project: nil, region: nil, region_set_policy_request_resource: nil, resource: nil) -> ::Google::Cloud::Compute::V1::Policy
Sets the access control policy on the specified resource. Replaces any existing policy.
def set_iam_policy(request, options = nil) -> ::Google::Cloud::Compute::V1::Policy
set_iam_policy
via a request object, either of type
Google::Cloud::Compute::V1::SetIamPolicySubnetworkRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::SetIamPolicySubnetworkRequest, ::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 set_iam_policy(project: nil, region: nil, region_set_policy_request_resource: nil, resource: nil) -> ::Google::Cloud::Compute::V1::Policy
set_iam_policy
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).
- project (::String) — Project ID for this request.
- region (::String) — The name of the region for this request.
- region_set_policy_request_resource (::Google::Cloud::Compute::V1::RegionSetPolicyRequest, ::Hash) — The body resource for this request
- resource (::String) — Name or id of the resource for this request.
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::Policy)
- response (::Faraday::Response)
- (::Google::Cloud::Error) — if the REST call is aborted.
#set_private_ip_google_access
def set_private_ip_google_access(request, options = nil) -> ::Gapic::GenericLRO::Operation
def set_private_ip_google_access(project: nil, region: nil, request_id: nil, subnetwork: nil, subnetworks_set_private_ip_google_access_request_resource: nil) -> ::Gapic::GenericLRO::Operation
Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access.
def set_private_ip_google_access(request, options = nil) -> ::Gapic::GenericLRO::Operation
set_private_ip_google_access
via a request object, either of type
Google::Cloud::Compute::V1::SetPrivateIpGoogleAccessSubnetworkRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::SetPrivateIpGoogleAccessSubnetworkRequest, ::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 set_private_ip_google_access(project: nil, region: nil, request_id: nil, subnetwork: nil, subnetworks_set_private_ip_google_access_request_resource: nil) -> ::Gapic::GenericLRO::Operation
set_private_ip_google_access
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).
- project (::String) — Project ID for this request.
- region (::String) — Name of the region scoping 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).
- subnetwork (::String) — Name of the Subnetwork resource.
- subnetworks_set_private_ip_google_access_request_resource (::Google::Cloud::Compute::V1::SubnetworksSetPrivateIpGoogleAccessRequest, ::Hash) — The body resource for this request
- (result, response) — Access the result along with the Faraday response object
- result (::Gapic::GenericLRO::Operation)
- response (::Faraday::Response)
- (::Gapic::GenericLRO::Operation)
- (::Google::Cloud::Error) — if the REST call is aborted.
#test_iam_permissions
def test_iam_permissions(request, options = nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse
def test_iam_permissions(project: nil, region: nil, resource: nil, test_permissions_request_resource: nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse
Returns permissions that a caller has on the specified resource.
def test_iam_permissions(request, options = nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse
test_iam_permissions
via a request object, either of type
TestIamPermissionsSubnetworkRequest or an equivalent Hash.
- request (::Google::Cloud::Compute::V1::TestIamPermissionsSubnetworkRequest, ::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 test_iam_permissions(project: nil, region: nil, resource: nil, test_permissions_request_resource: nil) -> ::Google::Cloud::Compute::V1::TestPermissionsResponse
test_iam_permissions
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).
- project (::String) — Project ID for this request.
- region (::String) — The name of the region for this request.
- resource (::String) — Name or id of the resource for this request.
- test_permissions_request_resource (::Google::Cloud::Compute::V1::TestPermissionsRequest, ::Hash) — The body resource for this request
- (result, response) — Access the result along with the Faraday response object
- result (::Google::Cloud::Compute::V1::TestPermissionsResponse)
- response (::Faraday::Response)
- (::Google::Cloud::Error) — if the REST call is aborted.