# Copyright 2023 Google LLC. All Rights Reserved.
# 
# 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.
info:
  title: Compute/VpnGateway
  description: The Compute VpnGateway resource
  x-dcl-struct-name: VpnGateway
  x-dcl-has-iam: false
paths:
  get:
    description: The function used to get information about a VpnGateway
    parameters:
    - name: vpnGateway
      required: true
      description: A full instance of a VpnGateway
  apply:
    description: The function used to apply information about a VpnGateway
    parameters:
    - name: vpnGateway
      required: true
      description: A full instance of a VpnGateway
  delete:
    description: The function used to delete a VpnGateway
    parameters:
    - name: vpnGateway
      required: true
      description: A full instance of a VpnGateway
  deleteAll:
    description: The function used to delete all VpnGateway
    parameters:
    - name: project
      required: true
      schema:
        type: string
    - name: location
      required: true
      schema:
        type: string
  list:
    description: The function used to list information about many VpnGateway
    parameters:
    - name: project
      required: true
      schema:
        type: string
    - name: location
      required: true
      schema:
        type: string
components:
  schemas:
    VpnGateway:
      title: VpnGateway
      x-dcl-id: projects/{{project}}/regions/{{location}}/vpnGateways/{{name}}
      x-dcl-parent-container: project
      x-dcl-labels: labels
      x-dcl-has-create: true
      x-dcl-has-iam: false
      x-dcl-read-timeout: 0
      x-dcl-apply-timeout: 0
      x-dcl-delete-timeout: 0
      type: object
      required:
      - name
      - network
      - project
      properties:
        description:
          type: string
          x-dcl-go-name: Description
          description: |-
            An optional description of this resource. Provide this property when you
            create the resource.
          x-kubernetes-immutable: true
        id:
          type: integer
          format: int64
          x-dcl-go-name: Id
          readOnly: true
          description: |-
            [Output Only] The unique identifier for the resource. This identifier is
            defined by the server.
          x-kubernetes-immutable: true
        labelFingerprint:
          type: string
          x-dcl-go-name: LabelFingerprint
          readOnly: true
          description: The fingerprint used for optimistic locking of this resource.  Used
            internally during updates.
        labels:
          type: object
          additionalProperties:
            type: string
          x-dcl-go-name: Labels
          description: Labels for this resource. These can only be added or modified
            by the `setLabels` method. Each label key/value pair must comply with
            [RFC1035](https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty.
        location:
          type: string
          x-dcl-go-name: Location
          description: |-
            URL of the region where the target VPN gateway resides.
            You must specify this field as part of the HTTP request URL. It is
            not settable as a field in the request body.
          x-kubernetes-immutable: true
        name:
          type: string
          x-dcl-go-name: 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 with
            <a href="https://www.ietf.org/rfc/rfc1035.txt" target="_blank">RFC1035</a>.
            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.
          x-kubernetes-immutable: true
        network:
          type: string
          x-dcl-go-name: Network
          description: |-
            URL of the network to which this VPN gateway is attached. Provided by the
            client when the VPN gateway is created.
          x-kubernetes-immutable: true
          x-dcl-references:
          - resource: Compute/Network
            field: selfLink
        project:
          type: string
          x-dcl-go-name: Project
          description: The project for the resource
          x-kubernetes-immutable: true
          x-dcl-references:
          - resource: Cloudresourcemanager/Project
            field: name
            parent: true
        selfLink:
          type: string
          x-dcl-go-name: SelfLink
          readOnly: true
          description: '[Output Only] Server-defined URL for the resource.'
          x-kubernetes-immutable: true
        vpnInterfaces:
          type: array
          x-dcl-go-name: VpnInterfaces
          readOnly: true
          description: A list of interfaces on this VPN gateway.
          x-kubernetes-immutable: true
          x-dcl-list-type: list
          items:
            type: object
            x-dcl-go-type: VpnGatewayVpnInterfaces
            properties:
              id:
                type: integer
                format: int64
                x-dcl-go-name: Id
                readOnly: true
                description: The numeric ID of this VPN gateway interface.
                x-kubernetes-immutable: true
              ipAddress:
                type: string
                x-dcl-go-name: IPAddress
                readOnly: true
                description: '[Output Only] The external IP address for this VPN gateway
                  interface.'
                x-kubernetes-immutable: true