<?php
/*
 * Copyright 2014 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

namespace Google\Service\Compute\Resource;

use Google\Service\Compute\Operation;
use Google\Service\Compute\WireGroup;
use Google\Service\Compute\WireGroupList;

/**
 * The "wireGroups" collection of methods.
 * Typical usage is:
 *  <code>
 *   $computeService = new Google\Service\Compute(...);
 *   $wireGroups = $computeService->wireGroups;
 *  </code>
 */
class WireGroups extends \Google\Service\Resource
{
  /**
   * Deletes the specified wire group in the given scope. (wireGroups.delete)
   *
   * @param string $project Project ID for this request.
   * @param string $crossSiteNetwork
   * @param string $wireGroup Name of the wire group resource to delete.
   * @param array $optParams Optional parameters.
   *
   * @opt_param string requestId 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
   * @return Operation
   * @throws \Google\Service\Exception
   */
  public function delete($project, $crossSiteNetwork, $wireGroup, $optParams = [])
  {
    $params = ['project' => $project, 'crossSiteNetwork' => $crossSiteNetwork, 'wireGroup' => $wireGroup];
    $params = array_merge($params, $optParams);
    return $this->call('delete', [$params], Operation::class);
  }
  /**
   * Gets the specified wire group resource in the given scope. (wireGroups.get)
   *
   * @param string $project Project ID for this request.
   * @param string $crossSiteNetwork
   * @param string $wireGroup Name of the wire group resource to return.
   * @param array $optParams Optional parameters.
   * @return WireGroup
   * @throws \Google\Service\Exception
   */
  public function get($project, $crossSiteNetwork, $wireGroup, $optParams = [])
  {
    $params = ['project' => $project, 'crossSiteNetwork' => $crossSiteNetwork, 'wireGroup' => $wireGroup];
    $params = array_merge($params, $optParams);
    return $this->call('get', [$params], WireGroup::class);
  }
  /**
   * Creates a wire group in the specified project in the given scope using the
   * parameters that are included in the request. (wireGroups.insert)
   *
   * @param string $project Project ID for this request.
   * @param string $crossSiteNetwork
   * @param WireGroup $postBody
   * @param array $optParams Optional parameters.
   *
   * @opt_param string requestId 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
   * @opt_param bool validateOnly [Input Only] Validate the new configuration, but
   * don't create it.
   * @return Operation
   * @throws \Google\Service\Exception
   */
  public function insert($project, $crossSiteNetwork, WireGroup $postBody, $optParams = [])
  {
    $params = ['project' => $project, 'crossSiteNetwork' => $crossSiteNetwork, 'postBody' => $postBody];
    $params = array_merge($params, $optParams);
    return $this->call('insert', [$params], Operation::class);
  }
  /**
   * Lists the wire groups for a project in the given scope.
   * (wireGroups.listWireGroups)
   *
   * @param string $project Project ID for this request.
   * @param string $crossSiteNetwork
   * @param array $optParams Optional parameters.
   *
   * @opt_param string filter 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.
   * @opt_param string maxResults 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`)
   * @opt_param string orderBy 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.
   * @opt_param string pageToken Specifies a page token to use. Set `pageToken` to
   * the `nextPageToken` returned by a previous list request to get the next page
   * of results.
   * @opt_param bool returnPartialSuccess 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.
   * @return WireGroupList
   * @throws \Google\Service\Exception
   */
  public function listWireGroups($project, $crossSiteNetwork, $optParams = [])
  {
    $params = ['project' => $project, 'crossSiteNetwork' => $crossSiteNetwork];
    $params = array_merge($params, $optParams);
    return $this->call('list', [$params], WireGroupList::class);
  }
  /**
   * 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. (wireGroups.patch)
   *
   * @param string $project Project ID for this request.
   * @param string $crossSiteNetwork
   * @param string $wireGroup Name of the WireGroups resource to patch.
   * @param WireGroup $postBody
   * @param array $optParams Optional parameters.
   *
   * @opt_param string requestId 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
   * @opt_param string updateMask update_mask indicates fields to be updated as
   * part of this request.
   * @opt_param bool validateOnly [Input Only] Validate the new configuration, but
   * don't update it.
   * @return Operation
   * @throws \Google\Service\Exception
   */
  public function patch($project, $crossSiteNetwork, $wireGroup, WireGroup $postBody, $optParams = [])
  {
    $params = ['project' => $project, 'crossSiteNetwork' => $crossSiteNetwork, 'wireGroup' => $wireGroup, 'postBody' => $postBody];
    $params = array_merge($params, $optParams);
    return $this->call('patch', [$params], Operation::class);
  }
}

// Adding a class alias for backwards compatibility with the previous class name.
class_alias(WireGroups::class, 'Google_Service_Compute_Resource_WireGroups');
