# Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::WireGroups::Rest::Client (v3.7.0)

3.7.0 (latest) 3.6.0 3.5.0 3.4.0 3.3.0 3.2.0 3.1.0 3.0.0 2.22.0 2.21.1 2.20.0 2.19.1 2.18.0 2.17.0 2.16.0 2.15.0 2.14.0 2.13.0 2.12.0 2.11.0 2.10.0 2.9.0 2.8.0 2.7.2 2.6.0 2.5.0 2.4.0 2.3.0 2.2.0 2.1.0 2.0.0 1.10.0 1.9.0 1.8.0 1.7.1 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0 0.5.0 Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::WireGroups::Rest::Client.

REST client for the WireGroups service.


<br />

The WireGroups API.

## Inherits

- Object

## Methods

### .configure

    def self.configure() { |config| ... } -> Client::Configuration

Configure the WireGroups Client class.


<br />

See [Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-WireGroups-Rest-Client-Configuration "Google::Cloud::Compute::V1::WireGroups::Rest::Client::Configuration (class)")
for a description of the configuration fields.
**Yields**

- (config) --- Configure the Client client.
**Yield Parameter**

- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-WireGroups-Rest-Client-Configuration))
**Returns**

- ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-WireGroups-Rest-Client-Configuration))
**Example**

```ruby
# Modify the configuration for all WireGroups clients
::Google::Cloud::Compute::V1::WireGroups::Rest::Client.configure do |config|
  config.timeout = 10.0
end
```

### #configure

    def configure() { |config| ... } -> Client::Configuration

Configure the WireGroups 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](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-WireGroups-Rest-Client#Google__Cloud__Compute__V1__WireGroups__Rest__Client_configure_class_ "Google::Cloud::Compute::V1::WireGroups::Rest::Client.configure (method)").

<br />

See [Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-WireGroups-Rest-Client-Configuration "Google::Cloud::Compute::V1::WireGroups::Rest::Client::Configuration (class)")
for a description of the configuration fields.
**Yields**

- (config) --- Configure the Client client.
**Yield Parameter**

- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-WireGroups-Rest-Client-Configuration))
**Returns**

- ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-WireGroups-Rest-Client-Configuration))

### #delete

    def delete(request, options = nil) -> ::Gapic::GenericLRO::Operation
    def delete(cross_site_network: nil, project: nil, request_id: nil, wire_group: nil) -> ::Gapic::GenericLRO::Operation

Deletes the specified wire group in the given scope.
**Overloads**

    def delete(request, options = nil) -> ::Gapic::GenericLRO::Operation

Pass arguments to `delete` via a request object, either of type [DeleteWireGroupRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-DeleteWireGroupRequest "Google::Cloud::Compute::V1::DeleteWireGroupRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Compute::V1::DeleteWireGroupRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-DeleteWireGroupRequest), ::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.

    def delete(cross_site_network: nil, project: nil, request_id: nil, wire_group: nil) -> ::Gapic::GenericLRO::Operation

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). **Parameters**

- **cross_site_network** (::String)
- **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).
  end_interface: MixerMutationRequestBuilder
- **wire_group** (::String) --- Name of the wire group resource to delete.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** (::Gapic::GenericLRO::Operation)
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- (::Gapic::GenericLRO::Operation)
**Raises**

- (::Google::Cloud::Error) --- if the REST call is aborted.
**Example**

Basic example

```ruby
require "google/cloud/compute/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::WireGroups::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::DeleteWireGroupRequest.new

# Call the delete method.
result = client.delete request

# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result
```

### #get

    def get(request, options = nil) -> ::Google::Cloud::Compute::V1::WireGroup
    def get(cross_site_network: nil, project: nil, wire_group: nil) -> ::Google::Cloud::Compute::V1::WireGroup

Gets the specified wire group resource in the given scope.
**Overloads**

    def get(request, options = nil) -> ::Google::Cloud::Compute::V1::WireGroup

Pass arguments to `get` via a request object, either of type [GetWireGroupRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-GetWireGroupRequest "Google::Cloud::Compute::V1::GetWireGroupRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Compute::V1::GetWireGroupRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-GetWireGroupRequest), ::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.

    def get(cross_site_network: nil, project: nil, wire_group: nil) -> ::Google::Cloud::Compute::V1::WireGroup

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). **Parameters**

- **cross_site_network** (::String)
- **project** (::String) --- Project ID for this request.
- **wire_group** (::String) --- Name of the wire group resource to return.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** ([::Google::Cloud::Compute::V1::WireGroup](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-WireGroup))
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- ([::Google::Cloud::Compute::V1::WireGroup](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-WireGroup))
**Raises**

- (::Google::Cloud::Error) --- if the REST call is aborted.
**Example**

Basic example

```ruby
require "google/cloud/compute/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::WireGroups::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::GetWireGroupRequest.new

# Call the get method.
result = client.get request

# The returned object is of type Google::Cloud::Compute::V1::WireGroup.
p result
```

### #global_operations

    def global_operations() -> ::Google::Cloud::Compute::V1::GlobalOperations::Rest::Client

Get the associated client for long-running operations via GlobalOperations.
**Returns**

- ([::Google::Cloud::Compute::V1::GlobalOperations::Rest::Client](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-GlobalOperations-Rest-Client))

### #initialize

    def initialize() { |config| ... } -> Client

Create a new WireGroups REST client object.
**Yields**

- (config) --- Configure the WireGroups client.
**Yield Parameter**

- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-WireGroups-Rest-Client-Configuration))
**Returns**

- ([Client](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-WireGroups-Rest-Client)) --- a new instance of Client
**Example**

```ruby
# Create a client using the default configuration
client = ::Google::Cloud::Compute::V1::WireGroups::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Compute::V1::WireGroups::Rest::Client.new do |config|
  config.timeout = 10.0
end
```

### #insert

    def insert(request, options = nil) -> ::Gapic::GenericLRO::Operation
    def insert(cross_site_network: nil, project: nil, request_id: nil, validate_only: nil, wire_group_resource: nil) -> ::Gapic::GenericLRO::Operation

Creates a wire group in the specified project in the given scope
using the parameters that are included in the request.
**Overloads**

    def insert(request, options = nil) -> ::Gapic::GenericLRO::Operation

Pass arguments to `insert` via a request object, either of type [InsertWireGroupRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-InsertWireGroupRequest "Google::Cloud::Compute::V1::InsertWireGroupRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Compute::V1::InsertWireGroupRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-InsertWireGroupRequest), ::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.

    def insert(cross_site_network: nil, project: nil, request_id: nil, validate_only: nil, wire_group_resource: nil) -> ::Gapic::GenericLRO::Operation

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). **Parameters**

- **cross_site_network** (::String)
- **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).
  end_interface: MixerMutationRequestBuilder
- **validate_only** (::Boolean) --- \[Input Only\] Validate the new configuration, but don't create it.
- **wire_group_resource** ([::Google::Cloud::Compute::V1::WireGroup](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-WireGroup), ::Hash) --- The body resource for this request
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** (::Gapic::GenericLRO::Operation)
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- (::Gapic::GenericLRO::Operation)
**Raises**

- (::Google::Cloud::Error) --- if the REST call is aborted.
**Example**

Basic example

```ruby
require "google/cloud/compute/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::WireGroups::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::InsertWireGroupRequest.new

# Call the insert method.
result = client.insert request

# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result
```

### #list

    def list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::WireGroup>
    def list(cross_site_network: nil, filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::WireGroup>

Lists the wire groups for a project in the given scope.
**Overloads**

    def list(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::WireGroup>

Pass arguments to `list` via a request object, either of type [ListWireGroupsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-ListWireGroupsRequest "Google::Cloud::Compute::V1::ListWireGroupsRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Compute::V1::ListWireGroupsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-ListWireGroupsRequest), ::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.

    def list(cross_site_network: nil, filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Compute::V1::WireGroup>

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). **Parameters**

- **cross_site_network** (::String)
- **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. 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 onresource 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 GoogleRE2 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.
- **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`)
- **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.
- **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.
- **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.


  For example, when partial success behavior is enabled, aggregatedList for a
  single zone scope either returns all resources in the zone or no resources,
  with an error code.
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** (::Gapic::Rest::PagedEnumerable\<[::Google::Cloud::Compute::V1::WireGroup](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-WireGroup)\>)
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- (::Gapic::Rest::PagedEnumerable\<[::Google::Cloud::Compute::V1::WireGroup](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-WireGroup)\>)
**Raises**

- (::Google::Cloud::Error) --- if the REST call is aborted.
**Example**

Basic example

```ruby
require "google/cloud/compute/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::WireGroups::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::ListWireGroupsRequest.new

# Call the list method.
result = client.list request

# The returned object is of type Google::Cloud::Compute::V1::WireGroupList.
p result
```

### #logger

    def logger() -> Logger

The logger used for request/response debug logging.
**Returns**

- (Logger)

### #patch

    def patch(request, options = nil) -> ::Gapic::GenericLRO::Operation
    def patch(cross_site_network: nil, project: nil, request_id: nil, update_mask: nil, validate_only: nil, wire_group: nil, wire_group_resource: nil) -> ::Gapic::GenericLRO::Operation

Updates the specified wire group resource with the data included in the
request. This method supportsPATCH
semantics and usesJSON merge
patch format and processing rules.
**Overloads**

    def patch(request, options = nil) -> ::Gapic::GenericLRO::Operation

Pass arguments to `patch` via a request object, either of type [PatchWireGroupRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-PatchWireGroupRequest "Google::Cloud::Compute::V1::PatchWireGroupRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Compute::V1::PatchWireGroupRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-PatchWireGroupRequest), ::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.

    def patch(cross_site_network: nil, project: nil, request_id: nil, update_mask: nil, validate_only: nil, wire_group: nil, wire_group_resource: nil) -> ::Gapic::GenericLRO::Operation

Pass arguments to `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). **Parameters**

- **cross_site_network** (::String)
- **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).
  end_interface: MixerMutationRequestBuilder
- **update_mask** (::String) --- update_mask indicates fields to be updated as part of this request.
- **validate_only** (::Boolean) --- \[Input Only\] Validate the new configuration, but don't update it.
- **wire_group** (::String) --- Name of the WireGroups resource to patch.
- **wire_group_resource** ([::Google::Cloud::Compute::V1::WireGroup](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-WireGroup), ::Hash) --- The body resource for this request
**Yields**

- (result, operation) --- Access the result along with the TransportOperation object
**Yield Parameters**

- **result** (::Gapic::GenericLRO::Operation)
- **operation** (::Gapic::Rest::TransportOperation)
**Returns**

- (::Gapic::GenericLRO::Operation)
**Raises**

- (::Google::Cloud::Error) --- if the REST call is aborted.
**Example**

Basic example

```ruby
require "google/cloud/compute/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Compute::V1::WireGroups::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Compute::V1::PatchWireGroupRequest.new

# Call the patch method.
result = client.patch request

# The returned object is of type Google::Cloud::Compute::V1::Operation.
p result
```

### #universe_domain

    def universe_domain() -> String

The effective universe domain
**Returns**

- (String)