wire_groups

Creates, updates, deletes, gets or lists a wire_groups resource.

Overview

Name	wire_groups
Type	Resource
Id	google.compute.wire_groups

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string (uint64)	Output only. [Output Only] The unique identifier for the resource type. The server generates this identifier.
name	string	Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. (pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)
adminEnabled	boolean	Indicates whether the wires in the wire group are enabled. When false, the wires in the wire group are disabled. When true and when there is simultaneously no wire-specific override of adminEnabled to false, a given wire is enabled. Defaults to true.
creationTimestamp	string	Output only. [Output Only] Creation timestamp inRFC3339 text format.
description	string	An optional description of the wire group.
endpoints	object	A map that contains the logical endpoints of the wire group. Specify key-value pairs for the map as follows: - Key: an RFC1035 user-specified label. - Value: an Endpoint object.
kind	string	Output only. [Output Only] Type of the resource. Alwayscompute#wireGroups for wire groups. (default: compute#wireGroup)
reconciling	boolean	Output only. [Output Only] Indicates whether there are wire changes yet to be processed.
selfLink	string	Output only. [Output Only] Server-defined URL for the resource.
topology	object	Output only. Topology details for the wire group configuration. (id: WireGroupTopology)
wireProperties	object	Properties for all wires in the wire group. (id: WireProperties)
wires	array	Output only. The single/redundant wire(s) managed by the wire group.

list

Name	Datatype	Description
id	string	[Output Only] Unique identifier for the resource; defined by the server.
etag	string
items	array	A list of wire group resources.
kind	string	Output only. [Output Only] Type of the resource. Alwayscompute#wireGroups for wire groups. (default: compute#wireGroup)
nextPageToken	string	[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLink	string	[Output Only] Server-defined URL for this resource.
unreachables	array	Output only. [Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder
warning	object	[Output Only] Informational warning message.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	project, crossSiteNetwork, wireGroup		Gets the specified wire group resource in the given scope.
list	select	project, crossSiteNetwork	returnPartialSuccess, orderBy, maxResults, pageToken, filter	Lists the wire groups for a project in the given scope.
insert	insert	project, crossSiteNetwork	requestId, validateOnly	Creates a wire group in the specified project in the given scope using the parameters that are included in the request.
patch	update	project, crossSiteNetwork, wireGroup	requestId, updateMask, validateOnly	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.
delete	delete	project, crossSiteNetwork, wireGroup	requestId	Deletes the specified wire group in the given scope.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
crossSiteNetwork	string
project	string
wireGroup	string
filter	string
maxResults	integer (uint32)
orderBy	string
pageToken	string
requestId	string
returnPartialSuccess	boolean
updateMask	string (google-fieldmask)
validateOnly	boolean

SELECT examples

get

Gets the specified wire group resource in the given scope.

SELECT
id,
name,
adminEnabled,
creationTimestamp,
description,
endpoints,
kind,
reconciling,
selfLink,
topology,
wireProperties,
wires
FROM google.compute.wire_groups
WHERE project = '{{ project }}' -- required
AND crossSiteNetwork = '{{ crossSiteNetwork }}' -- required
AND wireGroup = '{{ wireGroup }}' -- required
;

list

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

SELECT
id,
etag,
items,
kind,
nextPageToken,
selfLink,
unreachables,
warning
FROM google.compute.wire_groups
WHERE project = '{{ project }}' -- required
AND crossSiteNetwork = '{{ crossSiteNetwork }}' -- required
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
AND orderBy = '{{ orderBy }}'
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
;

INSERT examples

insert

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

INSERT INTO google.compute.wire_groups (
data__adminEnabled,
data__wireProperties,
data__name,
data__endpoints,
data__description,
project,
crossSiteNetwork,
requestId,
validateOnly
)
SELECT 
{{ adminEnabled }},
'{{ wireProperties }}',
'{{ name }}',
'{{ endpoints }}',
'{{ description }}',
'{{ project }}',
'{{ crossSiteNetwork }}',
'{{ requestId }}',
'{{ validateOnly }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

Manifest

# Description fields are for documentation purposes
- name: wire_groups
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the wire_groups resource.
  - name: crossSiteNetwork
    value: "{{ crossSiteNetwork }}"
    description: Required parameter for the wire_groups resource.
  - name: adminEnabled
    value: {{ adminEnabled }}
    description: |
      Indicates whether the wires in the wire group are enabled. When false, the
      wires in the wire group are disabled. When true and when
      there is simultaneously no wire-specific override of `adminEnabled` to
      false, a given wire is enabled. Defaults to true.
  - name: wireProperties
    description: |
      Properties for all wires in the wire group.
    value:
      bandwidthUnmetered: "{{ bandwidthUnmetered }}"
      bandwidthAllocation: "{{ bandwidthAllocation }}"
      faultResponse: "{{ faultResponse }}"
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource. Provided by the client when the resource is created.
      The name must be 1-63 characters long, and comply withRFC1035.
      Specifically, the name must be 1-63 characters long and match the regular
      expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
      character must be a lowercase letter, and all following characters must
      be a dash, lowercase letter, or digit, except the last character, which
      cannot be a dash.
  - name: endpoints
    value: "{{ endpoints }}"
    description: |
      A map that contains the logical endpoints of the wire group. Specify
      key-value pairs for the map as follows:
      - Key: an RFC1035 user-specified label.
      - Value: an Endpoint object.
  - name: description
    value: "{{ description }}"
    description: |
      An optional description of the wire group.
  - name: requestId
    value: "{{ requestId }}"
  - name: validateOnly
    value: {{ validateOnly }}

UPDATE examples

patch

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.

UPDATE google.compute.wire_groups
SET 
data__adminEnabled = {{ adminEnabled }},
data__wireProperties = '{{ wireProperties }}',
data__name = '{{ name }}',
data__endpoints = '{{ endpoints }}',
data__description = '{{ description }}'
WHERE 
project = '{{ project }}' --required
AND crossSiteNetwork = '{{ crossSiteNetwork }}' --required
AND wireGroup = '{{ wireGroup }}' --required
AND requestId = '{{ requestId}}'
AND updateMask = '{{ updateMask}}'
AND validateOnly = {{ validateOnly}}
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone;

DELETE examples

delete

Deletes the specified wire group in the given scope.

DELETE FROM google.compute.wire_groups
WHERE project = '{{ project }}' --required
AND crossSiteNetwork = '{{ crossSiteNetwork }}' --required
AND wireGroup = '{{ wireGroup }}' --required
AND requestId = '{{ requestId }}'
;