feat: Add new gcloud commands, API clients, and third-party libraries across various services.

This commit is contained in:
2026-01-01 20:26:35 +01:00
parent 5e23cbece0
commit a19e592eb7
25221 changed files with 8324611 additions and 0 deletions

View File

@@ -0,0 +1,49 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha AWSV4Signature export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
accessKey:
description: |-
The access key used for s3 bucket authentication. Required for updating or
creating a backend that uses AWS v4 signature authentication, but will not
be returned as part of the configuration when queried with a REST API GET
request. @InputOnly
type: string
accessKeyId:
description: |-
The identifier of an access key used for s3 bucket authentication.
type: string
accessKeyVersion:
description: |-
The optional version identifier for the access key. You can use this to
keep track of different iterations of your access key.
type: string
originRegion:
description: |-
The name of the cloud region of your origin. This is a free- form field
with the name of the region your cloud uses to host your origin. For
example, "us-east-1" for AWS or "us-ashburn-1" for OCI.
type: string

View File

@@ -0,0 +1,39 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha AcceleratorConfig export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
acceleratorCount:
description: |-
The number of the guest accelerator cards exposed to this instance.
type: integer
acceleratorType:
description: |-
Full or partial URL of the accelerator type resource to attach to this
instance. For example: projects/my-project/zones/us-
central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an
instance template, specify only the accelerator name. See GPUs on Compute
Engine for a full list of accelerator types.
type: string

View File

@@ -0,0 +1,96 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha AccessConfig export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
externalIpv6:
description: |-
[Output Only] The first IPv6 address of the external IPv6 range associated
with this instance, prefix length is stored in externalIpv6PrefixLength in
ipv6AccessConfig. The field is output only, an IPv6 address from a
subnetwork associated with the instance will be allocated dynamically.
type: string
externalIpv6PrefixLength:
description: '[Output Only] The prefix length of the external IPv6 range.'
type: integer
kind:
description: |-
[Output Only] Type of the resource. Always compute#accessConfig for access
configs.
type: string
name:
description: |-
The name of this access configuration. The default and recommended name is
External NAT, but you can use any arbitrary string, such as My external IP
or Network Access.
type: string
natIP:
description: |-
An external IP address associated with this instance. Specify an unused
static external IP address available to the project or leave this field
undefined to use an IP from a shared ephemeral IP address pool. If you
specify a static external IP address, it must live in the same region as
the zone of the instance.
type: string
networkTier:
description: |-
This signifies the networking tier used for configuring this access
configuration and can only take the following values: PREMIUM, STANDARD.
If an AccessConfig is specified without a valid external IP address, an
ephemeral IP will be created with this networkTier. If an AccessConfig
with a valid external IP address is specified, it must match that of the
networkTier associated with the Address resource owning that IP.
type: string
enum:
- FIXED_STANDARD
- PREMIUM
- SELECT
- STANDARD
- STANDARD_OVERRIDES_FIXED_STANDARD
publicDnsName:
description: '[Output Only] The public DNS domain name for the instance.'
type: string
publicPtrDomainName:
description: |-
The DNS domain name for the public PTR record. You can set this field only
if the `setPublicPtr` field is enabled.
type: string
setPublicDns:
description: |-
Specifies whether a public DNS 'A' record should be created for the
external IP address of this access configuration.
type: boolean
setPublicPtr:
description: |-
Specifies whether a public DNS 'PTR' record should be created to map the
external IP address of the instance to a DNS domain name.
type: boolean
type:
description: |-
The type of configuration. The default and only option is ONE_TO_ONE_NAT.
type: string
enum:
- DIRECT_IPV6
- ONE_TO_ONE_NAT

View File

@@ -0,0 +1,68 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha AdvancedMachineFeatures export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
enableNestedVirtualization:
description: |-
Whether to enable nested virtualization or not (default is false).
type: boolean
threadsPerCore:
description: |-
The number of threads per physical core. To disable simultaneous
multithreading (SMT) set this to 1. If unset, the maximum number of
threads supported per core by the underlying processor is assumed.
type: integer
numaNodeCount:
description: |-
The number of virtual NUMA nodes.
type: integer
visibleCoreCount:
description: |-
The number of physical cores to expose to the instance's guest operating
system. The number of virtual CPUs visible to the instance's guest
operating system is this number of cores multiplied by the instance's
count of visible threads per physical core.
type: integer
enableUefiNetworking:
description: |-
Whether to enable UEFI networking during instance creation.
type: boolean
performanceMonitoringUnit:
description: |-
The set of performance measurement counters to enable for the instance.
type: string
enum:
- ARCHITECTURAL
- STANDARD
- ENHANCED
enableWatchdogTimer:
description: |-
Whether to enable watchdog timer device during instance creation.
type: boolean
turboMode:
description: |-
The turbo frequency of the instance.
type: string

View File

@@ -0,0 +1,41 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha AliasIpRange export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
ipCidrRange:
description: |-
The IP alias ranges to allocate for this interface. This IP CIDR range
must belong to the specified subnetwork and cannot contain IP addresses
reserved by system or used by other network interfaces. This range may be
a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-
formatted string (such as 10.1.2.0/24).
type: string
subnetworkRangeName:
description: |-
The name of a subnetwork secondary IP range from which to allocate an IP
alias range. If not specified, the primary range of the subnetwork is
used.
type: string

View File

@@ -0,0 +1,166 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha AttachedDisk export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
autoDelete:
description: |-
Specifies whether the disk will be auto-deleted when the instance is
deleted (but not when the disk is detached from the instance).
type: boolean
boot:
description: |-
Indicates that this is a boot disk. The virtual machine will use the first
partition of the disk for its root filesystem.
type: boolean
deviceName:
description: |-
Specifies a unique device name of your choice that is reflected into the
/dev/disk/by-id/google-* tree of a Linux operating system running within
the instance. This name can be used to reference the device for mounting,
resizing, and so on, from within the instance. If not specified, the
server chooses a default device name to apply to this disk, in the form
persistent-disk-x, where x is a number assigned by Google Compute Engine.
This field is only applicable for persistent disks.
type: string
diskEncryptionKey:
description: |-
Encrypts or decrypts a disk using a customer-supplied encryption key. If
you are creating a new disk, this field encrypts the new disk using an
encryption key that you provide. If you are attaching an existing disk
that is already encrypted, this field decrypts the disk using the
customer-supplied encryption key. If you encrypt a disk using a customer-
supplied key, you must provide the same key again when you attempt to use
this resource at a later time. For example, you must provide the key when
you create a snapshot or an image from the disk or when you attach the
disk to a virtual machine instance. If you do not provide an encryption
key, then the disk will be encrypted using an automatically generated key
and you do not need to provide a key to use the disk later. Instance
templates do not store customer-supplied encryption keys, so you cannot
use your own keys to encrypt disks in a managed instance group.
$ref: CustomerEncryptionKey.yaml
diskSizeGb:
description: The size of the disk in GB.
type: integer
forceAttach:
description: |-
[Input Only] Whether to force attach the regional disk even if it's
currently attached to another instance. If you try to force attach a zonal
disk to an instance, you will receive an error.
type: boolean
guestOsFeatures:
description: |-
A list of features to enable on the guest operating system. Applicable
only for bootable images. Read Enabling guest operating system features
to see a list of available options.
type: array
items:
$ref: GuestOsFeature.yaml
index:
description: |-
[Output Only] A zero-based index to this disk, where 0 is reserved for
the boot disk. If you have many disks attached to an instance, each
disk would have a unique index number.
type: integer
initializeParams:
description: |-
[Input Only] Specifies the parameters for a new disk that will be
created alongside the new instance. Use initialization parameters to
create boot disks or local SSDs attached to the new instance. This
property is mutually exclusive with the source property; you can only
define one or the other, but not both.
$ref: AttachedDiskInitializeParams.yaml
interface:
description: |-
Specifies the disk interface to use for attaching this disk, which is
either SCSI or NVME. The default is SCSI. Persistent disks must always
use SCSI and the request will fail if you attempt to attach a
persistent disk in any other format than SCSI. Local SSDs can use
either NVME or SCSI. For performance characteristics of SCSI over
NVMe, see Local SSD performance.
type: string
enum:
- NVDIMM
- NVME
- SCSI
kind:
description: |-
[Output Only] Type of the resource. Always compute#attachedDisk for
attached disks.
type: string
licenses:
description: '[Output Only] Any valid publicly visible licenses.'
type: array
items:
type: string
mode:
description: |-
The mode in which to attach this disk, either READ_WRITE or
READ_ONLY. If not specified, the default is to attach the disk in
READ_WRITE mode.
type: string
enum:
- READ_ONLY
- READ_WRITE
savedState:
description: |-
For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state,
this field is set to PRESERVED if the LocalSSD data has been saved
to a persistent location by customer request. (see the
discard_local_ssd option on Stop/Suspend). Read-only in the api.
type: string
enum:
- DISK_SAVED_STATE_UNSPECIFIED
- PRESERVED
shieldedInstanceInitialState:
description: '[Output Only] shielded vm initial state stored on disk'
$ref: InitialStateConfig.yaml
source:
description: |-
Specifies a valid partial or full URL to an existing Persistent
Disk resource. When creating a new instance, one of
initializeParams.sourceImage or initializeParams.sourceSnapshot or
disks.source is required except for local SSD. If desired, you
can also attach existing non-root persistent disks using this
property. This field is only applicable for persistent disks.
Note that for InstanceTemplate, specify the disk name, not the URL
for the disk.
type: string
type:
description: |-
Specifies the type of the disk, either SCRATCH or PERSISTENT. If
not specified, the default is PERSISTENT.
type: string
enum:
- PERSISTENT
- SCRATCH
userLicenses:
description: |-
[Output Only] A list of user provided licenses. It represents a
list of URLs to the license resource. Unlike regular licenses,
user provided licenses can be modified after the disk is created.
type: array
items:
type: string

View File

@@ -0,0 +1,135 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha AttachedDiskInitializeParams export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
description:
description: |-
An optional description. Provide this property when creating the disk.
type: string
diskName:
description: |-
Specifies the disk name. If not specified, the default is to use the name
of the instance. If a disk with the same name already exists in the given
region, the existing disk is attached to the new instance and the new disk
is not created.
type: string
diskSizeGb:
description: |-
Specifies the size of the disk in base-2 GB. The size must be at least 10
GB. If you specify a sourceImage, which is required for boot disks, the
default size is the size of the sourceImage. If you do not specify a
sourceImage, the default disk size is 500 GB.
type: integer
diskType:
description: |-
Specifies the disk type to use to create the instance. If not specified,
the default is pd-standard, specified using the full URL. For
type: string
guestOsFeatures:
description: |-
A list of features to enable on the guest operating system. Applicable
only for bootable images. Read Enabling guest operating system features
to see a list of available options. Guest OS features are applied by
merging initializeParams.guestOsFeatures and disks.guestOsFeatures
type: array
items:
$ref: GuestOsFeature.yaml
labels:
description: |-
Labels to apply to this disk. These can be later modified by the
disks.setLabels method. This field is only applicable for persistent
disks.
$ref: LabelsValue.yaml
multiWriter:
description: |-
Indicates whether or not the disk can be read/write attached to more
than one instance.
type: boolean
onUpdateAction:
description: |-
Specifies which action to take on instance update with this disk.
Default is to use the existing disk.
type: string
enum:
- RECREATE_DISK
- RECREATE_DISK_IF_SOURCE_CHANGED
- USE_EXISTING_DISK
provisionedIops:
description: Indicates how many IOPS must be provisioned for the disk.
type: integer
replicaZones:
description: |-
URLs of the zones where the disk should be replicated to. Only
applicable for regional resources.
type: array
items:
type: string
resourcePolicies:
description: |-
Resource policies applied to this disk for automatic snapshot
creations. Specified using the full or partial URL. For instance
template, specify only the resource policy name.
type: array
items:
type: string
sourceImage:
description: |-
The source image to create this disk. When creating a new
instance, one of initializeParams.sourceImage or
initializeParams.sourceSnapshot or disks.source is required
except for local SSD. To create a disk with one of the public
operating system images, specify the image by its family name.
For example, specify family/debian-9 to use the latest Debian
9 image: projects/debian- cloud/global/images/family/debian-9
Alternatively, use a specific version of a public operating
system image: projects/debian-
cloud/global/images/debian-9-stretch-vYYYYMMDD To create a
disk with a custom image that you created, specify the image
name in the following
type: string
sourceImageEncryptionKey:
description: |-
The customer-supplied encryption key of the source image.
Required if the source image is protected by a customer-
supplied encryption key. Instance templates do not store
customer- supplied encryption keys, so you cannot create disks
for instances in a managed instance group if the source images
are encrypted with your own keys.
$ref: CustomerEncryptionKey.yaml
sourceSnapshot:
description: |-
The source snapshot to create this disk. When creating a new
instance, one of initializeParams.sourceSnapshot or
initializeParams.sourceImage or disks.source is required
except for local SSD. To create a disk with a snapshot that
you created, specify the snapshot name in the following
format: global/snapshots/my-backup If the source snapshot is
deleted later, this field will not be set.
type: string
sourceSnapshotEncryptionKey:
description: |-
The customer-supplied encryption key of the source snapshot.
$ref: CustomerEncryptionKey.yaml

View File

@@ -0,0 +1,68 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha AuthenticationPolicy export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
origins:
description: |-
List of authentication methods that can be used for origin authentication.
Similar to peers, these will be evaluated in order the first valid one
will be used to set origin identity. If none of these methods pass, the
request will be rejected with authentication failed error (401). Leave the
list empty if origin authentication is not required.
type: array
items:
$ref: OriginAuthenticationMethod.yaml
peers:
description: |-
List of authentication methods that can be used for peer
authentication. They will be evaluated in order the first valid one
will be used to set peer identity. If none of these methods pass, the
request will be rejected with authentication failed error (401). Leave
the list empty if peer authentication is not required.
type: array
items:
$ref: PeerAuthenticationMethod.yaml
principalBinding:
description: |-
Define whether peer or origin identity should be used for
principal. Default value is USE_PEER. If peer (or origin) identity
is not available, either because peer/origin authentication is not
defined, or failed, principal will be left unset. In other words,
binding rule does not affect the decision to accept or reject
request. This field can be set to one of the following: USE_PEER:
Principal will be set to the identity from peer authentication.
USE_ORIGIN: Principal will be set to the identity from origin
authentication.
type: string
enum:
- INVALID
- USE_ORIGIN
- USE_PEER
serverTlsContext:
description: |-
Configures the mechanism to obtain server-side security
certificates and identity information.
$ref: TlsContext.yaml

View File

@@ -0,0 +1,32 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha AuthorizationConfig export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
policies:
description: List of RbacPolicies.
type: array
items:
$ref: RbacPolicy.yaml

View File

@@ -0,0 +1,162 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha Backend export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
balancingMode:
description: |-
Specifies how to determine whether the backend of a load balancer can
handle additional traffic or is fully loaded. For usage guidelines, see
Connection balancing mode. Backends must use compatible balancing modes.
For more information, see Supported balancing modes and target capacity
settings and Restrictions and guidance for instance groups. Note:
Currently, if you use the API to configure incompatible balancing modes,
the configuration might be accepted even though it has no impact and is
ignored. Specifically, Backend.maxUtilization is ignored when
Backend.balancingMode is RATE. In the future, this incompatible
combination will be rejected.
type: string
enum:
- CONNECTION
- CUSTOM_METRICS
- IN_FLIGHT
- RATE
- UTILIZATION
capacityScaler:
description: |-
A multiplier applied to the backend's target capacity of its balancing
mode. The default value is 1, which means the group serves up to 100% of
its configured capacity (depending on balancingMode). A setting of 0 means
the group is completely drained, offering 0% of its available capacity.
The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting
larger than 0 and smaller than 0.1. You cannot configure a setting of 0
when there is only one backend attached to the backend service. Not
available with backends that don't support using a balancingMode. This
includes backends such as global internet NEGs, regional serverless NEGs,
and PSC NEGs.
type: number
customMetrics:
description: |-
List of custom metrics that are used for CUSTOM_METRICS BalancingMode.
type: array
items:
$ref: BackendCustomMetric.yaml
description:
description: |-
An optional description of this resource. Provide this property when
you create the resource.
type: string
failover:
description: |-
This field designates whether this is a failover backend. More than
one failover backend can be configured for a given BackendService.
type: boolean
group:
description: |-
The fully-qualified URL of an instance group or network endpoint group
(NEG) resource. To determine what types of backends a load balancer
supports, see the [Backend services
overview](https://cloud.google.com/load-balancing/docs/backend-
service#backends). You must use the *fully-qualified* URL (starting
with https://www.googleapis.com/) to specify the instance group or
NEG. Partial URLs are not supported. If haPolicy is specified,
backends must refer to NEG resources of type GCE_VM_IP.
type: string
maxConnections:
description: |-
Defines a target maximum number of simultaneous connections. For usage
guidelines, see Connection balancing mode and Utilization balancing
mode. Not available if the backend's balancingMode is RATE.
type: integer
maxConnectionsPerEndpoint:
description: |-
Defines a target maximum number of simultaneous connections. For usage
guidelines, see Connection balancing mode and Utilization balancing
mode. Not available if the backend's balancingMode is RATE.
type: integer
maxConnectionsPerInstance:
description: |-
Defines a target maximum number of simultaneous connections. For usage
guidelines, see Connection balancing mode and Utilization balancing
mode. Not available if the backend's balancingMode is RATE.
type: integer
maxInFlightRequests:
description: |-
Defines a maximum number of in-flight requests for the whole NEG or
instance group. Not available if backend's balancingMode is RATE or
CONNECTION.
type: integer
maxInFlightRequestsPerEndpoint:
description: |-
Defines a maximum number of in-flight requests for a single endpoint.
Not available if backend's balancingMode is RATE or CONNECTION.
type: integer
maxInFlightRequestsPerInstance:
description: |-
Defines a maximum number of in-flight requests for a single VM. Not
available if backend's balancingMode is RATE or CONNECTION.
type: integer
maxRate:
description: |-
Defines a maximum number of HTTP requests per second (RPS). For usage
guidelines, see Rate balancing mode and Utilization balancing mode.
Not available if the backend's balancingMode is CONNECTION.
type: integer
maxRatePerEndpoint:
description: |-
Defines a maximum target for requests per second (RPS). For usage
guidelines, see Rate balancing mode and Utilization balancing mode.
Not available if the backend's balancingMode is CONNECTION.
type: number
maxRatePerInstance:
description: |-
Defines a maximum target for requests per second (RPS). For usage
guidelines, see Rate balancing mode and Utilization balancing mode.
Not available if the backend's balancingMode is CONNECTION.
type: number
maxUtilization:
description: |-
Optional parameter to define a target capacity for the UTILIZATION
balancing mode. The valid range is [0.0, 1.0]. For usage guidelines,
see Utilization balancing mode.
type: number
preference:
description: |-
This field indicates whether this backend should be fully utilized
before sending traffic to backends with default preference. The
possible values are: - PREFERRED: Backends with this preference level
will be filled up to their capacity limits first, based on RTT. -
type: string
enum:
- DEFAULT
- PREFERENCE_UNSPECIFIED
- PREFERRED
trafficDuration:
description: A TrafficDurationValueValuesEnum attribute.
type: string
enum:
- LONG
- SHORT
- TRAFFIC_DURATION_UNSPECIFIED

View File

@@ -0,0 +1,49 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha BackendCustomMetric export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
dryRun:
description: |-
If true, the metric data is collected and reported to Cloud Monitoring,
but is not used for load balancing.
type: boolean
maxUtilization:
description: |-
Optional parameter to define a target utilization for the Custom Metrics
balancing mode. The valid range is [0.0, 1.0].
type: number
name:
description: |-
Name of a custom utilization signal. The name must be 1-64 characters long
and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means
that the first character must be a lowercase letter, and all following
characters must be a dash, period, underscore, lowercase letter, or digit,
except the last character, which cannot be a dash, period, or underscore.
For usage guidelines, see Custom Metrics balancing mode. This field can
only be used for a global or regional backend service with the
loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED
INTERNAL_SELF_MANAGED.
type: string

View File

@@ -0,0 +1,620 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha BackendService export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
affinityCookieTtlSec:
description: |-
Lifetime of cookies in seconds. This setting is applicable to Application
Load Balancers and Traffic Director and requires GENERATED_COOKIE or
HTTP_COOKIE session affinity. If set to 0, the cookie is non-persistent
and lasts only until the end of the browser session (or equivalent). The
maximum allowed value is two weeks (1,209,600). Not supported when the
backend service is referenced by a URL map that is bound to target gRPC
proxy that has validateForProxyless field set to true.
type: integer
allowMultinetwork:
description: |-
A boolean flag enabling multi-network mesh. This field is only allowed
with load balancing scheme set to INTERNAL_SELF_MANAGED.
type: boolean
backends:
description: The list of backends that serve this BackendService.
type: array
items:
$ref: Backend.yaml
cdnPolicy:
description: |-
Cloud CDN configuration for this BackendService. Only available for
specified load balancer types.
$ref: BackendServiceCdnPolicy.yaml
circuitBreakers:
description: A CircuitBreakers attribute.
$ref: CircuitBreakers.yaml
compressionMode:
description: |-
Compress text responses using Brotli or gzip compression, based on the
client's Accept-Encoding header.
type: string
enum:
- AUTOMATIC
- DISABLED
connectionDraining:
description: connectionDraining cannot be specified with haPolicy.
$ref: ConnectionDraining.yaml
connectionTrackingPolicy:
description: |-
Connection Tracking configuration for this BackendService. Connection
tracking policy settings are only available for external passthrough
Network Load Balancers and internal passthrough Network Load
Balancers. connectionTrackingPolicy cannot be specified with haPolicy.
$ref: BackendServiceConnectionTrackingPolicy.yaml
consistentHash:
description: |-
Consistent Hash-based load balancing can be used to provide soft
session affinity based on HTTP headers, cookies or other properties.
This load balancing policy is applicable only for HTTP connections.
The affinity to a particular destination host will be lost when one or
more hosts are added/removed from the destination service. This field
specifies parameters that control consistent hashing. This field is
only applicable when localityLbPolicy is set to MAGLEV or RING_HASH.
This field is applicable to either: - A regional backend service with
the service_protocol set to HTTP, HTTPS, HTTP2 or H2C, and
load_balancing_scheme set to INTERNAL_MANAGED. - A global backend
service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED.
$ref: ConsistentHashLoadBalancerSettings.yaml
creationTimestamp:
description: '[Output Only] Creation timestamp in RFC3339 text format.'
type: string
customMetrics:
description: |-
List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN
locality_lb_policy.
type: array
items:
$ref: BackendServiceCustomMetric.yaml
customRequestHeaders:
description: |-
Headers that the load balancer adds to proxied requests. See
[Creating custom headers](https://cloud.google.com/load-
balancing/docs/custom-headers).
type: array
items:
type: string
customResponseHeaders:
description: |-
Headers that the load balancer adds to proxied responses. See
[Creating custom headers](https://cloud.google.com/load-
balancing/docs/custom-headers).
type: array
items:
type: string
description:
description: |-
An optional description of this resource. Provide this
property when you create the resource.
type: string
dynamicForwarding:
description: |-
Dynamic forwarding configuration. This field is used to
configure the backend service with dynamic forwarding
feature which together with Service Extension allows
customized and complex routing logic.
$ref: BackendServiceDynamicForwarding.yaml
edgeSecurityPolicy:
description: |-
[Output Only] The resource URL for the edge security
policy associated with this backend service.
type: string
enableCDN:
description: |-
If true, enables Cloud CDN for the backend service of a
global external Application Load Balancer.
type: boolean
externalManagedMigrationState:
description: |-
Specifies the canary migration state. Possible values are
PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To
begin the migration from EXTERNAL to EXTERNAL_MANAGED, the
state must be changed to PREPARE. The state must be
changed to TEST_ALL_TRAFFIC before the loadBalancingScheme
can be changed to EXTERNAL_MANAGED. Optionally, the
TEST_BY_PERCENTAGE state can be used to migrate traffic by
percentage using
externalManagedMigrationTestingPercentage. Rolling back a
migration requires the states to be set in reverse order.
So changing the scheme from EXTERNAL_MANAGED to EXTERNAL
requires the state to be set to TEST_ALL_TRAFFIC at the
same time. Optionally, the TEST_BY_PERCENTAGE state can be
used to migrate some traffic back to EXTERNAL or PREPARE
can be used to migrate all traffic back to EXTERNAL.
type: string
enum:
- PREPARE
- TEST_ALL_TRAFFIC
- TEST_BY_PERCENTAGE
externalManagedMigrationTestingPercentage:
description: |-
Determines the fraction of requests that should be
processed by the Global external Application Load
Balancer. The value of this field must be in the range [0,
100]. Session affinity options will slightly affect this
routing behavior, for more details, see: Session Affinity.
This value can only be set if the loadBalancingScheme in
the BackendService is set to EXTERNAL (when using the
classic Application Load Balancer) and the migration state
is TEST_BY_PERCENTAGE.
type: number
failoverPolicy:
description: |-
Requires at least one backend instance group to be defined
as a backup (failover) backend. For load balancers that
have configurable failover: [Internal passthrough Network
Load Balancers](https://cloud.google.com/load-
balancing/docs/internal/failover-overview) and [external
passthrough Network Load
Balancers](https://cloud.google.com/load-
balancing/docs/network/networklb-failover-overview).
failoverPolicy cannot be specified with haPolicy.
$ref: BackendServiceFailoverPolicy.yaml
fingerprint:
description: |-
Fingerprint of this resource. A hash of the contents
stored in this object. This field is used in optimistic
locking. This field will be ignored when inserting a
BackendService. An up-to-date fingerprint must be provided
in order to update the BackendService, otherwise the
request will fail with error 412 conditionNotMet. To see
the latest fingerprint, make a get() request to retrieve a
BackendService.
type: string
haPolicy:
description: |-
Configures self-managed High Availability (HA) for
External and Internal Protocol Forwarding. The backends of
this regional backend service must only specify zonal
network endpoint groups (NEGs) of type GCE_VM_IP. When
haPolicy is set for an Internal Passthrough Network Load
Balancer, the regional backend service must set the
network field. All zonal NEGs must belong to the same
network. However, individual NEGs can belong to different
subnetworks of that network. When haPolicy is specified,
the set of attached network endpoints across all backends
comprise an High Availability domain from which one
endpoint is selected as the active endpoint (the leader)
that receives all traffic. haPolicy can be added only at
backend service creation time. Once set up, it cannot be
deleted. Note that haPolicy is not for load balancing, and
therefore cannot be specified with sessionAffinity,
connectionTrackingPolicy, and failoverPolicy. haPolicy
requires customers to be responsible for tracking backend
endpoint health and electing a leader among the healthy
endpoints. Therefore, haPolicy cannot be specified with
healthChecks. haPolicy can only be specified for External
Passthrough Network Load Balancers and Internal
Passthrough Network Load Balancers.
$ref: BackendServiceHAPolicy.yaml
healthChecks:
description: |-
The list of URLs to the healthChecks, httpHealthChecks
(legacy), or httpsHealthChecks (legacy) resource for
health checking this backend service. Not all backend
services support legacy health checks. See Load balancer
guide. Currently, at most one health check can be
specified for each backend service. Backend services with
instance group or zonal NEG backends must have a health
check unless haPolicy is specified. Backend services with
internet or serverless NEG backends must not have a health
check. healthChecks[] cannot be specified with haPolicy.
type: array
items:
type: string
iap:
description: |-
The configurations for Identity-Aware Proxy on this
resource. Not available for internal passthrough
Network Load Balancers and external passthrough
Network Load Balancers.
$ref: BackendServiceIAP.yaml
ipAddressSelectionPolicy:
description: |-
Specifies a preference for traffic sent from the proxy
to the backend (or from the client to the backend for
proxyless gRPC). The possible values are: - IPV4_ONLY:
Only send IPv4 traffic to the backends of the backend
service (Instance Group, Managed Instance Group,
Network Endpoint Group), regardless of traffic from
the client to the proxy. Only IPv4 health checks are
used to check the health of the backends. This is the
default setting. - PREFER_IPV6: Prioritize the
connection to the endpoint's IPv6 address over its
IPv4 address (provided there is a healthy IPv6
address). - IPV6_ONLY: Only send IPv6 traffic to the
backends of the backend service (Instance Group,
Managed Instance Group, Network Endpoint Group),
regardless of traffic from the client to the proxy.
Only IPv6 health checks are used to check the health
of the backends. This field is applicable to either: -
Advanced global external Application Load Balancer
(load balancing scheme EXTERNAL_MANAGED), - Regional
external Application Load Balancer, - Internal proxy
Network Load Balancer (load balancing scheme
INTERNAL_MANAGED), - Regional internal Application
Load Balancer (load balancing scheme
INTERNAL_MANAGED), - Traffic Director with Envoy
proxies and proxyless gRPC (load balancing scheme
INTERNAL_SELF_MANAGED).
type: string
enum:
- IPV4_ONLY
- IPV6_ONLY
- IP_ADDRESS_SELECTION_POLICY_UNSPECIFIED
- PREFER_IPV6
kind:
description: |-
[Output Only] Type of resource. Always
compute#backendService for backend services.
type: string
loadBalancingScheme:
description: |-
Specifies the load balancer type. A backend service
created for one type of load balancer cannot be used
with another. For more information, refer to Choosing
a load balancer.
type: string
enum:
- EXTERNAL
- EXTERNAL_MANAGED
- EXTERNAL_PASSTHROUGH
- INTERNAL
- INTERNAL_MANAGED
- INTERNAL_SELF_MANAGED
- INVALID_LOAD_BALANCING_SCHEME
localityLbPolicies:
description: |-
A list of locality load-balancing policies to be used
in order of preference. When you use
localityLbPolicies, you must set at least one value
for either the localityLbPolicies[].policy or the
localityLbPolicies[].customPolicy field.
localityLbPolicies overrides any value set in the
localityLbPolicy field. For an example of how to use
this field, see Define a list of preferred policies.
Caution: This field and its children are intended for
use in a service mesh that includes gRPC clients only.
Envoy proxies can't use backend services that have
this configuration.
type: array
items:
$ref: BackendServiceLocalityLoadBalancingPolicyConfig.yaml
localityLbPolicy:
description: |-
The load balancing algorithm used within the scope
of the locality. The possible values are: -
ROUND_ROBIN: This is a simple policy in which each
healthy backend is selected in round robin order.
This is the default. - LEAST_REQUEST: An O(1)
algorithm which selects two random healthy hosts
and picks the host which has fewer active
requests. - RING_HASH: The ring/modulo hash load
balancer implements consistent hashing to
backends. The algorithm has the property that the
addition/removal of a host from a set of N hosts
only affects 1/N of the requests. - RANDOM: The
load balancer selects a random healthy host. -
type: string
enum:
- INVALID_LB_POLICY
- LEAST_REQUEST
- MAGLEV
- ORIGINAL_DESTINATION
- RANDOM
- RING_HASH
- ROUND_ROBIN
- WEIGHTED_GCP_RENDEZVOUS
- WEIGHTED_MAGLEV
- WEIGHTED_ROUND_ROBIN
logConfig:
description: |-
This field denotes the logging options for the
load balancer traffic served by this backend
service. If logging is enabled, logs will be
exported to Stackdriver.
$ref: BackendServiceLogConfig.yaml
maxStreamDuration:
description: |-
Specifies the default maximum duration (timeout)
for streams to this service. Duration is computed
from the beginning of the stream until the
response has been completely processed, including
all retries. A stream that does not complete in
this duration is closed. If not specified, there
will be no timeout limit, i.e. the maximum
duration is infinite. This value can be overridden
in the PathMatcher configuration of the UrlMap
that references this backend service. This field
is only allowed when the loadBalancingScheme of
the backend service is INTERNAL_SELF_MANAGED.
$ref: Duration.yaml
metadatas:
description: |-
Deployment metadata associated with the resource
to be set by a GKE hub controller and read by the
backend RCTH
$ref: MetadatasValue.yaml
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 RFC1035.
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.
type: string
network:
description: |-
The URL of the network to which this backend
service belongs. This field must be set for
Internal Passthrough Network Load Balancers when
the haPolicy is enabled, and for External
Passthrough Network Load Balancers when the
haPolicy fastIpMove is enabled. This field can
only be specified when the load balancing scheme
is set to INTERNAL, or when the load balancing
scheme is set to EXTERNAL and haPolicy fastIpMove
is enabled.
type: string
networkPassThroughLbTrafficPolicy:
description: |-
Configures traffic steering properties of internal
passthrough Network Load Balancers.
networkPassThroughLbTrafficPolicy cannot be
specified with haPolicy.
$ref: BackendServiceNetworkPassThroughLbTrafficPolicy.yaml
outlierDetection:
description: |-
Settings controlling the ejection of unhealthy
backend endpoints from the load balancing pool of
each individual proxy instance that processes the
traffic for the given backend service. If not set,
this feature is considered disabled. Results of
the outlier detection algorithm (ejection of
endpoints from the load balancing pool and
returning them back to the pool) are executed
independently by each proxy instance of the load
balancer. In most cases, more than one proxy
instance handles the traffic received by a backend
service. Thus, it is possible that an unhealthy
endpoint is detected and ejected by only some of
the proxies, and while this happens, other proxies
may continue to send requests to the same
unhealthy endpoint until they detect and eject the
unhealthy endpoint. Applicable backend endpoints
can be: - VM instances in an Instance Group -
Endpoints in a Zonal NEG (GCE_VM_IP,
GCE_VM_IP_PORT) - Endpoints in a Hybrid
Connectivity NEG (NON_GCP_PRIVATE_IP_PORT) -
Serverless NEGs, that resolve to Cloud Run, App
Engine, or Cloud Functions Services - Private
Service Connect NEGs, that resolve to Google-
managed regional API endpoints or managed services
published using Private Service Connect Applicable
backend service types can be: - A global backend
service with the loadBalancingScheme set to
INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. - A
regional backend service with the serviceProtocol
set to HTTP, HTTPS, HTTP2 or H2C, and
loadBalancingScheme set to INTERNAL_MANAGED or
EXTERNAL_MANAGED. Not supported for Serverless
NEGs. Not supported when the backend service is
referenced by a URL map that is bound to target
gRPC proxy that has validateForProxyless field set
to true.
$ref: OutlierDetection.yaml
params:
description: |-
Input only. [Input Only] Additional params passed
with the request, but not persisted as part of
resource payload.
$ref: BackendServiceParams.yaml
port:
description: |-
Deprecated in favor of portName. The TCP port to
connect on the backend. The default value is 80.
For internal passthrough Network Load Balancers
and external passthrough Network Load Balancers,
omit port.
type: integer
portName:
description: |-
A named port on a backend instance group
representing the port for communication to the
backend VMs in that group. The named port must be
[defined on each backend instance
group](https://cloud.google.com/load-
balancing/docs/backend- service#named_ports). This
parameter has no meaning if the backends are NEGs.
For internal passthrough Network Load Balancers
and external passthrough Network Load Balancers,
omit port_name.
type: string
protocol:
description: |-
The protocol this BackendService uses to
communicate with backends. Possible values are
HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.
depending on the chosen load balancer or Traffic
Director configuration. Refer to the documentation
for the load balancers or for Traffic Director for
more information. Must be set to GRPC when the
backend service is referenced by a URL map that is
bound to target gRPC proxy.
type: string
enum:
- ALL
- GRPC
- H2C
- HTTP
- HTTP2
- HTTPS
- SSL
- TCP
- UDP
- UNSPECIFIED
region:
description: |-
[Output Only] URL of the region where the regional
backend service resides. This field is not
applicable to global backend services. You must
specify this field as part of the HTTP request
URL. It is not settable as a field in the request
body.
type: string
securityPolicy:
description: |-
[Output Only] The resource URL for the security
policy associated with this backend service.
type: string
securitySettings:
description: |-
This field specifies the security settings that
apply to this backend service. This field is
applicable to a global backend service with the
load_balancing_scheme set to
INTERNAL_SELF_MANAGED.
$ref: SecuritySettings.yaml
selfLink:
description: |-
[Output Only] Server-defined URL for the resource.
type: string
selfLinkWithId:
description: |-
[Output Only] Server-defined URL for this resource
with the resource id.
type: string
serviceBindings:
description: |-
URLs of networkservices.ServiceBinding resources.
Can only be set if load balancing scheme is
INTERNAL_SELF_MANAGED. If set, lists of backends
and health checks must be both empty.
type: array
items:
type: string
serviceLbPolicy:
description: |-
URL to networkservices.ServiceLbPolicy
resource. Can only be set if load balancing
scheme is EXTERNAL_MANAGED, INTERNAL_MANAGED
or INTERNAL_SELF_MANAGED and the scope is
global.
type: string
sessionAffinity:
description: |-
Type of session affinity to use. The default
is NONE. Only NONE and HEADER_FIELD are
supported when the backend service is
referenced by a URL map that is bound to
target gRPC proxy that has
validateForProxyless field set to true. For
more details, see: [Session
Affinity](https://cloud.google.com/load-
balancing/docs/backend-
service#session_affinity). sessionAffinity
cannot be specified with haPolicy.
type: string
enum:
- CLIENT_IP
- CLIENT_IP_NO_DESTINATION
- CLIENT_IP_PORT_PROTO
- CLIENT_IP_PROTO
- GENERATED_COOKIE
- HEADER_FIELD
- HTTP_COOKIE
- NONE
- STRONG_COOKIE_AFFINITY
strongSessionAffinityCookie:
description: |-
Describes the HTTP cookie used for stateful
session affinity. This field is applicable and
required if the sessionAffinity is set to
STRONG_COOKIE_AFFINITY.
$ref: BackendServiceHttpCookie.yaml
subsetting:
description: |-
subsetting cannot be specified with haPolicy.
$ref: Subsetting.yaml
timeoutSec:
description: |-
The backend service timeout has a different
meaning depending on the type of load
balancer. For more information see, Backend
service settings. The default is 30 seconds.
The full range of timeout values allowed goes
from 1 through 2,147,483,647 seconds. This
value can be overridden in the PathMatcher
configuration of the UrlMap that references
this backend service. Not supported when the
backend service is referenced by a URL map
that is bound to target gRPC proxy that has
validateForProxyless field set to true.
Instead, use maxStreamDuration.
type: integer
tlsSettings:
description: |-
Configuration for Backend Authenticated TLS
and mTLS. May only be specified when the
backend protocol is SSL, HTTPS or HTTP2.
$ref: BackendServiceTlsSettings.yaml
usedBy:
description: |-
[Output Only] List of resources referencing
given backend service.
type: array
items:
$ref: BackendServiceUsedBy.yaml
vpcNetworkScope:
description: |-
The network scope of the backends that can
be added to the backend service. This
field can be either GLOBAL_VPC_NETWORK or
REGIONAL_VPC_NETWORK. A backend service
with the VPC scope set to
GLOBAL_VPC_NETWORK is only allowed to have
backends in global VPC networks. When the
VPC scope is set to REGIONAL_VPC_NETWORK
the backend service is only allowed to
have backends in regional networks in the
same scope as the backend service. Note:
if not specified then GLOBAL_VPC_NETWORK
will be used.
type: string
enum:
- GLOBAL_VPC_NETWORK
- REGIONAL_VPC_NETWORK

View File

@@ -0,0 +1,42 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha BackendServiceAppEngineBackend export schema
description: A gcloud export/import command YAML validation schema.
type: object
required:
- targetProject
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
appEngineService:
description: App Engine app service name.
type: string
targetProject:
description: |-
Project ID of the project hosting the app. This is the project ID of this
project. Reference to another project is not allowed.
type: string
version:
description: |-
Version of App Engine app service. When empty, App Engine will do its
normal traffic split.
type: string

View File

@@ -0,0 +1,161 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha BackendServiceCdnPolicy export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
bypassCacheOnRequestHeaders:
description: |-
Bypass the cache when the specified request headers are matched - e.g.
Pragma or Authorization headers. Up to 5 headers can be specified. The
cache is bypassed for all cdnPolicy.cacheMode settings.
type: array
items:
$ref: BackendServiceCdnPolicyBypassCacheOnRequestHeader.yaml
cacheKeyPolicy:
description: The CacheKeyPolicy for this CdnPolicy.
$ref: CacheKeyPolicy.yaml
cacheMode:
description: |-
Specifies the cache setting for all responses from this backend. The
possible values are: USE_ORIGIN_HEADERS Requires the origin to set
valid caching headers to cache content. Responses without these
headers will not be cached at Google's edge, and will require a full
trip to the origin on every request, potentially impacting performance
and increasing load on the origin server. FORCE_CACHE_ALL Cache all
content, ignoring any "private", "no-store" or "no-cache" directives
in Cache-Control response headers. Warning: this may result in Cloud
CDN caching private, per-user (user identifiable) content.
CACHE_ALL_STATIC Automatically cache static content, including common
image formats, media (video and audio), and web assets (JavaScript and
CSS). Requests and responses that are marked as uncacheable, as well
as dynamic content (including HTML), will not be cached. If no value
is provided for cdnPolicy.cacheMode, it defaults to CACHE_ALL_STATIC.
type: string
enum:
- CACHE_ALL_STATIC
- FORCE_CACHE_ALL
- INVALID_CACHE_MODE
- USE_ORIGIN_HEADERS
clientTtl:
description: |-
Specifies a separate client (e.g. browser client) maximum TTL. This is
used to clamp the max-age (or Expires) value sent to the client. With
FORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for
the response max-age directive, along with a "public" directive. For
cacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-
age from the origin (if specified), or else sets the response max-age
directive to the lesser of the client_ttl and default_ttl, and also
ensures a "public" cache-control directive is present. If a client TTL
is not specified, a default value (1 hour) will be used. The maximum
allowed value is 31,622,400s (1 year).
type: integer
defaultTtl:
description: |-
Specifies the default TTL for cached content served by this origin for
responses that do not have an existing valid TTL (max-age or
s-maxage). Setting a TTL of "0" means "always revalidate". The value
of defaultTTL cannot be set to a value greater than that of maxTTL,
but can be equal. When the cacheMode is set to FORCE_CACHE_ALL, the
defaultTTL will overwrite the TTL set in all responses. The maximum
allowed value is 31,622,400s (1 year), noting that infrequently
accessed objects may be evicted from the cache before the defined TTL.
type: integer
maxTtl:
description: |-
Specifies the maximum allowed TTL for cached content served by this
origin. Cache directives that attempt to set a max-age or s-maxage
higher than this, or an Expires header more than maxTTL seconds in the
future will be capped at the value of maxTTL, as if it were the value
of an s-maxage Cache-Control directive. Headers sent to the client
will not be modified. Setting a TTL of "0" means "always revalidate".
The maximum allowed value is 31,622,400s (1 year), noting that
infrequently accessed objects may be evicted from the cache before the
defined TTL.
type: integer
negativeCaching:
description: |-
Negative caching allows per-status code TTLs to be set, in order to
apply fine-grained caching for common errors or redirects. This can
reduce the load on your origin and improve end-user experience by
reducing response latency. When the cache mode is set to
CACHE_ALL_STATIC or USE_ORIGIN_HEADERS, negative caching applies to
responses with the specified response code that lack any Cache-
Control, Expires, or Pragma: no-cache directives. When the cache mode
is set to FORCE_CACHE_ALL, negative caching applies to all responses
with the specified response code, and override any caching headers. By
default, Cloud CDN will apply the following default TTLs to these
status codes: HTTP 300 (Multiple Choice), 301, 308 (Permanent
Redirects): 10m HTTP 404 (Not Found), 410 (Gone), 451 (Unavailable For
Legal Reasons): 120s HTTP 405 (Method Not Found), 421 (Misdirected
Request), 501 (Not Implemented): 60s. These defaults can be overridden
in negative_caching_policy.
type: boolean
negativeCachingPolicy:
description: |-
Sets a cache TTL for the specified HTTP status code. negative_caching
must be enabled to configure negative_caching_policy. Omitting the
policy and leaving negative_caching enabled will use Cloud CDN's
default cache TTLs. Note that when specifying an explicit
negative_caching_policy, you should take care to specify a cache TTL
for all response codes that you wish to cache. Cloud CDN will not
apply any default negative caching when a policy exists.
type: array
items:
$ref: BackendServiceCdnPolicyNegativeCachingPolicy.yaml
requestCoalescing:
description: |-
If true then Cloud CDN will combine multiple concurrent cache fill
requests into a small number of requests to the origin.
type: boolean
serveWhileStale:
description: |-
Serve existing content from the cache (if available) when
revalidating content with the origin, or when an error is
encountered when refreshing the cache. This setting defines the
default "max-stale" duration for any cached responses that do not
specify a max-stale directive. Stale responses that exceed the TTL
configured here will not be served. The default limit (max-stale)
is 86400s (1 day), which will allow stale content to be served up
to this limit beyond the max-age (or s-maxage) of a cached
response. The maximum allowed value is 604800 (1 week). Set this
to zero (0) to disable serve-while-stale.
type: integer
signedUrlCacheMaxAgeSec:
description: |-
Maximum number of seconds the response to a signed URL request
will be considered fresh. After this time period, the response
will be revalidated before being served. Defaults to 1hr (3600s).
When serving responses to signed URL requests, Cloud CDN will
internally behave as though all responses from this backend had a
"Cache-Control: public, max-age=[TTL]" header, regardless of any
existing Cache-Control header. The actual headers served in
responses will not be altered.
type: integer
signedUrlKeyNames:
description: |-
[Output Only] Names of the keys for signing request URLs.
type: array
items:
type: string

View File

@@ -0,0 +1,32 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha BackendServiceCdnPolicyBypassCacheOnRequestHeader export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
headerName:
description: |-
The header field name to match on when bypassing cache. Values are case-
insensitive.
type: string

View File

@@ -0,0 +1,40 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha BackendServiceCdnPolicyNegativeCachingPolicy export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
code:
description: |-
The HTTP status code to define a TTL against. Only HTTP status codes 300,
301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 are can be specified
as values, and you cannot specify a status code more than once.
type: integer
ttl:
description: |-
The TTL (in seconds) for which to cache responses with the corresponding
status code. The maximum allowed value is 1800s (30 minutes), noting that
infrequently accessed objects may be evicted from the cache before the
defined TTL.
type: integer

View File

@@ -0,0 +1,38 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha BackendServiceCloudFunctionBackend export schema
description: A gcloud export/import command YAML validation schema.
type: object
required:
- functionName
- targetProject
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
functionName:
description: |-
A cloud function name. Special value ?*? represents all cloud functions in
the project.
type: string
targetProject:
description: Project ID of the project hosting the cloud function.
type: string

View File

@@ -0,0 +1,86 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha BackendServiceConnectionTrackingPolicy export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
connectionPersistenceOnUnhealthyBackends:
description: |-
Specifies connection persistence when backends are unhealthy. The default
value is DEFAULT_FOR_PROTOCOL. If set to DEFAULT_FOR_PROTOCOL, the
existing connections persist on unhealthy backends only for connection-
oriented protocols (TCP and SCTP) and only if the Tracking Mode is
PER_CONNECTION (default tracking mode) or the Session Affinity is
configured for 5-tuple. They do not persist for UDP. If set to
NEVER_PERSIST, after a backend becomes unhealthy, the existing connections
on the unhealthy backend are never persisted on the unhealthy backend.
They are always diverted to newly selected healthy backends (unless all
backends are unhealthy). If set to ALWAYS_PERSIST, existing connections
always persist on unhealthy backends regardless of protocol and session
affinity. It is generally not recommended to use this mode overriding the
default. For more details, see [Connection Persistence for Network Load
Balancing](https://cloud.google.com/load-
balancing/docs/network/networklb-backend-service#connection-persistence)
and [Connection Persistence for Internal TCP/UDP Load
Balancing](https://cloud.google.com/load-
balancing/docs/internal#connection-persistence).
type: string
enum:
- ALWAYS_PERSIST
- DEFAULT_FOR_PROTOCOL
- NEVER_PERSIST
enableStrongAffinity:
description: |-
Enable Strong Session Affinity for external passthrough Network Load
Balancers. This option is not available publicly.
type: boolean
idleTimeoutSec:
description: |-
Specifies how long to keep a Connection Tracking entry while there is no
matching traffic (in seconds). For internal passthrough Network Load
Balancers: - The minimum (default) is 10 minutes and the maximum is 16
hours. - It can be set only if Connection Tracking is less than 5-tuple
(i.e. Session Affinity is CLIENT_IP_NO_DESTINATION, CLIENT_IP or
CLIENT_IP_PROTO, and Tracking Mode is PER_SESSION). For external
passthrough Network Load Balancers the default is 60 seconds. This option
is not available publicly.
type: integer
trackingMode:
description: |-
Specifies the key used for connection tracking. There are two options: -
PER_CONNECTION: This is the default mode. The Connection Tracking is
performed as per the Connection Key (default Hash Method) for the specific
protocol. - PER_SESSION: The Connection Tracking is performed as per the
configured Session Affinity. It matches the configured Session Affinity.
For more details, see [Tracking Mode for Network Load
Balancing](https://cloud.google.com/load-
balancing/docs/network/networklb-backend-service#tracking-mode) and
[Tracking Mode for Internal TCP/UDP Load
Balancing](https://cloud.google.com/load-
balancing/docs/internal#tracking-mode).
type: string
enum:
- INVALID_TRACKING_MODE
- PER_CONNECTION
- PER_SESSION

View File

@@ -0,0 +1,42 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha BackendServiceCustomMetric export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
dryRun:
description: If true, the metric data is not used for load balancing.
type: boolean
name:
description: |-
Name of a custom utilization signal. The name must be 1-64 characters long
and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means
that the first character must be a lowercase letter, and all following
characters must be a dash, period, underscore, lowercase letter, or digit,
except the last character, which cannot be a dash, period, or underscore.
For usage guidelines, see Custom Metrics balancing mode. This field can
only be used for a global or regional backend service with the
loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED
INTERNAL_SELF_MANAGED.
type: string

View File

@@ -0,0 +1,30 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha BackendServiceDynamicForwarding export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
ipPortSelection:
description: IP:PORT based dynamic forwarding configuration.
$ref: BackendServiceDynamicForwardingIpPortSelection.yaml

View File

@@ -0,0 +1,30 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha BackendServiceDynamicForwardingIpPortSelection export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
enabled:
description: A boolean flag enabling IP:PORT based dynamic forwarding.
type: boolean

View File

@@ -0,0 +1,55 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha BackendServiceFailoverPolicy export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
disableConnectionDrainOnFailover:
description: |-
This can be set to true only if the protocol is TCP. The default is false.
type: boolean
dropTrafficIfUnhealthy:
description: |-
If set to true, connections to the load balancer are dropped when all
primary and all backup backend VMs are unhealthy.If set to false,
connections are distributed among all primary VMs when all primary and all
backup backend VMs are unhealthy. For load balancers that have
configurable failover: [Internal passthrough Network Load
Balancers](https://cloud.google.com/load-
balancing/docs/internal/failover-overview) and [external passthrough
Network Load Balancers](https://cloud.google.com/load-
balancing/docs/network/networklb-failover-overview). The default is false.
type: boolean
failoverRatio:
description: |-
The value of the field must be in the range [0, 1]. If the value is 0, the
load balancer performs a failover when the number of healthy primary VMs
equals zero. For all other values, the load balancer performs a failover
when the total number of healthy primary VMs is less than this ratio. For
load balancers that have configurable failover: [Internal TCP/UDP Load
Balancing](https://cloud.google.com/load-
balancing/docs/internal/failover-overview) and [external TCP/UDP Load
Balancing](https://cloud.google.com/load-
balancing/docs/network/networklb-failover-overview).
type: number

View File

@@ -0,0 +1,93 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha BackendServiceHAPolicy export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
fastIPMove:
description: |-
Specifies whether fast IP move is enabled, and if so, the mechanism to
achieve it. Supported values are: - DISABLED: Fast IP Move is disabled.
You can only use the haPolicy.leader API to update the leader. - >GARP_RA:
Provides a method to very quickly define a new network endpoint as the
leader. This method is faster than updating the leader using the
haPolicy.leader API. Fast IP move works as follows: The VM hosting the
network endpoint that should become the new leader sends either a
Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router Advertisement(RA)
packet (IPv6). Google Cloud immediately but temporarily associates the
forwarding rule IP address with that VM, and both new and in-flight
packets are quickly delivered to that VM. Note the important properties of
the Fast IP Move functionality: - The GARP/RA-initiated re-routing stays
active for approximately 20 minutes. After triggering fast failover, you
must also appropriately set the haPolicy.leader. - The new leader instance
should continue to send GARP/RA packets periodically every 10 seconds
until at least 10 minutes after updating the haPolicy.leader (but stop
immediately if it is no longer the leader). - After triggering a fast
failover, we recommend that you wait at least 3 seconds before sending
another GARP/RA packet from a different VM instance to avoid race
conditions. - Don't send GARP/RA packets from different VM instances at
the same time. If multiple instances continue to send GARP/RA packets,
traffic might be routed to different destinations in an alternating order.
This condition ceases when a single instance issues a GARP/RA packet. -
The GARP/RA request always takes priority over the leader API. Using the
haPolicy.leader API to change the leader to a different instance will have
no effect until the GARP/RA request becomes inactive. - The GARP/RA
packets should follow the GARP/RA Packet Specifications.. - When multiple
forwarding rules refer to a regional backend service, you need only send a
GARP or RA packet for a single forwarding rule virtual IP. The virtual IPs
for all forwarding rules targeting the same backend service will also be
moved to the sender of the GARP or RA packet. The following are the Fast
IP Move limitations (that is, when fastIPMove is not DISABLED): - Multiple
forwarding rules cannot use the same IP address if one of them refers to a
regional backend service with fastIPMove. - The regional backend service
must set the network field, and all NEGs must belong to that network.
However, individual NEGs can belong to different subnetworks of that
network. - The maximum number of network endpoints across all backends of
a backend service with fastIPMove is 32. - The maximum number of backend
services with fastIPMove that can have the same network endpoint attached
to one of its backends is 64. - The maximum number of backend services
with fastIPMove in a VPC in a region is 64. - The network endpoints that
are attached to a backend of a backend service with fastIPMove cannot
resolve to Gen3+ machines for IPv6. - Traffic directed to the leader by a
static route next hop will not be redirected to a new leader by fast
failover. Such traffic will only be redirected once an haPolicy.leader
update has taken effect. Only traffic to the forwarding rule's virtual IP
will be redirected to a new leader by fast failover. haPolicy.fastIPMove
can be set only at backend service creation time. Once set, it cannot be
updated. By default, fastIpMove is set to DISABLED.
type: string
enum:
- DISABLED
- GARP_RA
leader:
description: |-
Selects one of the network endpoints attached to the backend NEGs of this
service as the active endpoint (the leader) that receives all traffic.
When the leader changes, there is no connection draining to persist
existing connections on the old leader. You are responsible for selecting
a suitable endpoint as the leader. For example, preferring a healthy
endpoint over unhealthy ones. Note that this service does not track
backend endpoint health, and selects the configured leader
unconditionally.
$ref: BackendServiceHAPolicyLeader.yaml

View File

@@ -0,0 +1,42 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha BackendServiceHAPolicyLeader export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
backendGroup:
description: |-
A fully-qualified URL (starting with https://www.googleapis.com/) of the
zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints that the
leader is attached to. The leader's backendGroup must already be specified
as a backend of this backend service. Removing a backend that is
designated as the leader's backendGroup is not permitted.
type: string
networkEndpoint:
description: |-
The network endpoint within the leader.backendGroup that is designated as
the leader. This network endpoint cannot be detached from the NEG
specified in the haPolicy.leader.backendGroup until the leader is updated
with another network endpoint, or the leader is removed from the haPolicy.
$ref: BackendServiceHAPolicyLeaderNetworkEndpoint.yaml

View File

@@ -0,0 +1,35 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha BackendServiceHAPolicyLeaderNetworkEndpoint export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
instance:
description: |-
The name of the VM instance of the leader network endpoint. The instance
must already be attached to the NEG specified in the
haPolicy.leader.backendGroup. The name must be 1-63 characters long, and
comply with RFC1035. Authorization requires the following IAM permission
on the specified resource instance: compute.instances.use
type: string

View File

@@ -0,0 +1,36 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha BackendServiceHttpCookie export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
name:
description: Name of the cookie.
type: string
path:
description: Path to set for the cookie.
type: string
ttl:
description: Lifetime of the cookie.
$ref: Duration.yaml

View File

@@ -0,0 +1,51 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha BackendServiceIAP export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
enabled:
description: |-
Whether the serving infrastructure will authenticate and authorize all
incoming requests.
type: boolean
oauth2ClientId:
description: OAuth2 client ID to use for the authentication flow.
type: string
oauth2ClientInfo:
description: |-
[Input Only] OAuth client info required to generate client id to be used
for IAP.
$ref: BackendServiceIAPOAuth2ClientInfo.yaml
oauth2ClientSecret:
description: |-
OAuth2 client secret to use for the authentication flow. For security
reasons, this value cannot be retrieved via the API. Instead, the SHA-256
hash of the value is returned in the oauth2ClientSecretSha256 field.
@InputOnly
type: string
oauth2ClientSecretSha256:
description: |-
[Output Only] SHA256 hash value for the field oauth2_client_secret above.
type: string

View File

@@ -0,0 +1,38 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha BackendServiceIAPOAuth2ClientInfo export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
applicationName:
description: Application name to be used in OAuth consent screen.
type: string
clientName:
description: |-
Name of the client to be generated. Optional - If not provided, the name
will be autogenerated by the backend.
type: string
developerEmailAddress:
description: Developer's information to be used in OAuth consent screen.
type: string

View File

@@ -0,0 +1,35 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha BackendServiceLocalityLoadBalancingPolicyConfig export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
customPolicy:
description: |-
A BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicy attribute.
$ref: BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicy.yaml
policy:
description: |-
A BackendServiceLocalityLoadBalancingPolicyConfigPolicy attribute.
$ref: BackendServiceLocalityLoadBalancingPolicyConfigPolicy.yaml

View File

@@ -0,0 +1,43 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicy export
schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
data:
description: |-
An optional, arbitrary JSON object with configuration data, understood by
a locally installed custom policy implementation.
type: string
name:
description: |-
Identifies the custom policy. The value should match the name of a custom
implementation registered on the gRPC clients. It should follow protocol
buffer message naming conventions and include the full path (for example,
myorg.CustomLbPolicy). The maximum length is 256 characters. Do not
specify the same custom policy more than once for a backend. If you do,
the configuration is rejected. For an example of how to use this field,
see Use a custom policy.
type: string

View File

@@ -0,0 +1,47 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha BackendServiceLocalityLoadBalancingPolicyConfigPolicy export
schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
name:
description: |-
The name of a locality load-balancing policy. Valid values include
ROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information about
these values, see the description of localityLbPolicy. Do not specify the
same policy more than once for a backend. If you do, the configuration is
rejected.
type: string
enum:
- INVALID_LB_POLICY
- LEAST_REQUEST
- MAGLEV
- ORIGINAL_DESTINATION
- RANDOM
- RING_HASH
- ROUND_ROBIN
- WEIGHTED_GCP_RENDEZVOUS
- WEIGHTED_MAGLEV
- WEIGHTED_ROUND_ROBIN

View File

@@ -0,0 +1,74 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha BackendServiceLogConfig export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
enable:
description: |-
Denotes whether to enable logging for the load balancer traffic served by
this backend service. The default value is false.
type: boolean
optional:
description: |-
Deprecated in favor of optionalMode. This field can only be specified if
logging is enabled for this backend service. Configures whether all, none
or a subset of optional fields should be added to the reported logs. One
of [INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is
EXCLUDE_ALL_OPTIONAL.
type: string
enum:
- CUSTOM
- EXCLUDE_ALL_OPTIONAL
- INCLUDE_ALL_OPTIONAL
- UNSPECIFIED_OPTIONAL_MODE
optionalFields:
description: |-
This field can only be specified if logging is enabled for this backend
service and "logConfig.optionalMode" was set to CUSTOM. Contains a list of
optional fields you want to include in the logs. For
type: array
items:
type: string
optionalMode:
description: |-
This field can only be specified if logging is enabled for this
backend service. Configures whether all, none or a subset of optional
fields should be added to the reported logs. One of
[INCLUDE_ALL_OPTIONAL, EXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is
EXCLUDE_ALL_OPTIONAL.
type: string
enum:
- CUSTOM
- EXCLUDE_ALL_OPTIONAL
- INCLUDE_ALL_OPTIONAL
- UNSPECIFIED_OPTIONAL_MODE
sampleRate:
description: |-
This field can only be specified if logging is enabled for this
backend service. The value of the field must be in [0, 1]. This
configures the sampling rate of requests to the load balancer where
1.0 means all logged requests are reported and 0.0 means no logged
requests are reported. The default value is 1.0.
type: number

View File

@@ -0,0 +1,32 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha BackendServiceNetworkPassThroughLbTrafficPolicy export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
zonalAffinity:
description: |-
When configured, new connections are load balanced across healthy backend
endpoints in the local zone.
$ref: BackendServiceNetworkPassThroughLbTrafficPolicyZonalAffinity.yaml

View File

@@ -0,0 +1,50 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha BackendServiceNetworkPassThroughLbTrafficPolicyZonalAffinity
export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
spillover:
description: |-
This field indicates whether zonal affinity is enabled or not. The
possible values are: - ZONAL_AFFINITY_DISABLED: Default Value. Zonal
Affinity is disabled. The load balancer distributes new connections to all
healthy backend endpoints across all zones. -
type: string
enum:
- ZONAL_AFFINITY_DISABLED
- ZONAL_AFFINITY_SPILL_CROSS_ZONE
- ZONAL_AFFINITY_STAY_WITHIN_ZONE
spilloverRatio:
description: |-
The value of the field must be in [0, 1]. When the ratio of the count of
healthy backend endpoints in a zone to the count of backend endpoints in
that same zone is equal to or above this threshold, the load balancer
distributes new connections to all healthy endpoints in the local zone
only. When the ratio of the count of healthy backend endpoints in a zone
to the count of backend endpoints in that same zone is below this
threshold, the load balancer distributes all new connections to all
healthy endpoints across all zones.
type: number

View File

@@ -0,0 +1,38 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha BackendServiceParams export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
resourceManagerTags:
description: |-
Tag keys/values directly bound to this resource. Tag keys and values have
the same definition as resource manager tags. The field is allowed for
INSERT only. The keys/values to set on the resource should be specified in
either ID { : } or Namespaced format { : }. For example the following are
valid inputs: * {"tagKeys/333" : "tagValues/444", "tagKeys/123" :
"tagValues/456"} * {"123/environment" : "production", "345/abc" : "xyz"}
Note: * Invalid combinations of ID & namespaced format is not supported.
For instance: {"123/environment" : "tagValues/444"} is invalid.
$ref: ResourceManagerTagsValue.yaml

View File

@@ -0,0 +1,74 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha BackendServiceTlsSettings export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
authenticationConfig:
description: |-
Reference to the BackendAuthenticationConfig resource from the
networksecurity.googleapis.com namespace. Can be used in authenticating
TLS connections to the backend, as specified by the authenticationMode
field. Can only be specified if authenticationMode is not NONE.
type: string
identity:
description: |-
Assigns the Managed Identity for the RegionBackendService Workload. Use
this property to configure the load balancer back-end to use certificates
and roots of trust provisioned by the Managed Workload Identity system.
The `managedIdentity` property is the fully-specified SPIFFE ID to use in
the SVID presented by the Load Balancer Workload. The SPIFFE ID must be a
resource starting with the "spiffe" scheme identifier, followed by the
"trustDomain" property value, followed by the path to the Managed Workload
Identity. Supported SPIFFE ID format: -
spiffe://<trust_domain>/ns/<namespace>/sa/<subject> The Trust Domain
within the Managed Identity must refer to a valid Workload Identity Pool.
The TrustConfig and CertificateIssuanceConfig will be inherited from the
Workload Identity Pool. Restrictions: - If you set the `managedIdentity`
property, you cannot manually set the following
type: string
sni:
description: |-
Server Name Indication - see RFC3546 section 3.1. If set, the load
balancer sends this string as the SNI hostname in the TLS connection to
the backend, and requires that this string match a Subject Alternative
Name (SAN) in the backend's server certificate. With a Regional Internet
NEG backend, if the SNI is specified here, the load balancer uses it
regardless of whether the Regional Internet NEG is specified with FQDN or
IP address and port. When both sni and subjectAltNames[] are specified,
the load balancer matches the backend certificate's SAN only to
subjectAltNames[].
type: string
subjectAltNames:
description: |-
A list of Subject Alternative Names (SANs) that the Load Balancer verifies
during a TLS handshake with the backend. When the server presents its
X.509 certificate to the Load Balancer, the Load Balancer inspects the
certificate's SAN field, and requires that at least one SAN match one of
the subjectAltNames in the list. This field is limited to 5 entries. When
both sni and subjectAltNames[] are specified, the load balancer matches
the backend certificate's SAN only to subjectAltNames[].
type: array
items:
$ref: BackendServiceTlsSettingsSubjectAltName.yaml

View File

@@ -0,0 +1,33 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha BackendServiceTlsSettingsSubjectAltName export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
dnsName:
description: The SAN specified as a DNS Name.
type: string
uniformResourceIdentifier:
description: The SAN specified as a URI.
type: string

View File

@@ -0,0 +1,33 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha BackendServiceUsedBy export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
reference:
description: |-
[Output Only] Server-defined URL for resources referencing given
BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and
ForwardingRule.
type: string

View File

@@ -0,0 +1,74 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha CacheKeyPolicy export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
includeHost:
description: If true, requests to different hosts will be cached separately.
type: boolean
includeHttpHeaders:
description: |-
Allows HTTP request headers (by name) to be used in the cache key.
type: array
items:
type: string
includeNamedCookies:
description: |-
Allows HTTP cookies (by name) to be used in the cache key. The
name=value pair will be used in the cache key Cloud CDN generates.
type: array
items:
type: string
includeProtocol:
description: |-
If true, http and https requests will be cached separately.
type: boolean
includeQueryString:
description: |-
If true, include query string parameters in the cache key
according to query_string_whitelist and query_string_blacklist. If
neither is set, the entire query string will be included. If
false, the query string will be excluded from the cache key
entirely.
type: boolean
queryStringBlacklist:
description: |-
Names of query string parameters to exclude in cache keys. All
other parameters will be included. Either specify
query_string_whitelist or query_string_blacklist, not both. '&'
and '=' will be percent encoded and not treated as delimiters.
type: array
items:
type: string
queryStringWhitelist:
description: |-
Names of query string parameters to include in cache keys. All
other parameters will be excluded. Either specify
query_string_whitelist or query_string_blacklist, not both.
'&' and '=' will be percent encoded and not treated as
delimiters.
type: array
items:
type: string

View File

@@ -0,0 +1,41 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha CallCredentials export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
callCredentialType:
description: |-
The type of call credentials to use for GRPC requests to the SDS server.
This field can be set to one of the following: -
type: string
enum:
- FROM_PLUGIN
- GCE_VM
- INVALID
fromPlugin:
description: |-
Custom authenticator credentials. Valid if callCredentialType is
FROM_PLUGIN.
$ref: MetadataCredentialsFromPlugin.yaml

View File

@@ -0,0 +1,40 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha ChannelCredentials export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
certificates:
description: The call credentials to access the SDS server.
$ref: TlsCertificatePaths.yaml
channelCredentialType:
description: |-
The channel credentials to access the SDS server. This field can be set to
one of the following: CERTIFICATES: Use TLS certificates to access the SDS
server. GCE_VM: Use local GCE VM credentials to access the SDS server.
type: string
enum:
- CERTIFICATES
- GCE_VM
- INVALID

View File

@@ -0,0 +1,65 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha CircuitBreakers export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
connectTimeout:
description: The timeout for new network connections to hosts.
$ref: Duration.yaml
maxConnections:
description: |-
The maximum number of connections to the backend service. If not
specified, there is no limit. Not supported when the backend service is
referenced by a URL map that is bound to target gRPC proxy that has
validateForProxyless field set to true.
type: integer
maxPendingRequests:
description: |-
The maximum number of pending requests allowed to the backend service. If
not specified, there is no limit. Not supported when the backend service
is referenced by a URL map that is bound to target gRPC proxy that has
validateForProxyless field set to true.
type: integer
maxRequests:
description: |-
The maximum number of parallel requests that allowed to the backend
service. If not specified, there is no limit.
type: integer
maxRequestsPerConnection:
description: |-
Maximum requests for a single connection to the backend service. This
parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If
not specified, there is no limit. Setting this parameter to 1 will
effectively disable keep alive. Not supported when the backend service is
referenced by a URL map that is bound to target gRPC proxy that has
validateForProxyless field set to true.
type: integer
maxRetries:
description: |-
The maximum number of parallel retries allowed to the backend cluster. If
not specified, the default is 1. Not supported when the backend service is
referenced by a URL map that is bound to target gRPC proxy that has
validateForProxyless field set to true.
type: integer

View File

@@ -0,0 +1,61 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha ClientTlsSettings export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
clientTlsContext:
description: |-
Configures the mechanism to obtain client-side security certificates and
identity information. This field is only applicable when mode is set to
MUTUAL.
$ref: TlsContext.yaml
mode:
description: |-
Indicates whether connections to this port should be secured using TLS.
The value of this field determines how TLS is enforced. This can be set to
one of the following values: DISABLE: Do not setup a TLS connection to the
backends. SIMPLE: Originate a TLS connection to the backends. MUTUAL:
Secure connections to the backends using mutual TLS by presenting client
certificates for authentication.
type: string
enum:
- DISABLE
- INVALID
- MUTUAL
- SIMPLE
sni:
description: |-
SNI string to present to the server during TLS handshake. This field is
applicable only when mode is SIMPLE or MUTUAL.
type: string
subjectAltNames:
description: |-
A list of alternate names to verify the subject identity in the
certificate.If specified, the proxy will verify that the server
certificate's subject alt name matches one of the specified values. This
field is applicable only when mode is SIMPLE or MUTUAL.
type: array
items:
type: string

View File

@@ -0,0 +1,31 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha ConfidentialInstanceConfig export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
enableConfidentialCompute:
description: |-
Defines whether the instance should have confidential compute enabled.
type: boolean

View File

@@ -0,0 +1,33 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha ConnectionDraining export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
drainingTimeoutSec:
description: |-
Configures a duration timeout for existing requests on a removed backend
instance. For supported load balancers and protocols, as described in
Enabling connection draining.
type: integer

View File

@@ -0,0 +1,48 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha ConsistentHashLoadBalancerSettings export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
httpCookie:
description: |-
Hash is based on HTTP Cookie. This field describes a HTTP cookie that will
be used as the hash key for the consistent hash load balancer. If the
cookie is not present, it will be generated. This field is applicable if
the sessionAffinity is set to HTTP_COOKIE. Not supported when the backend
service is referenced by a URL map that is bound to target gRPC proxy that
has validateForProxyless field set to true.
$ref: ConsistentHashLoadBalancerSettingsHttpCookie.yaml
httpHeaderName:
description: |-
The hash based on the value of the specified header field. This field is
applicable if the sessionAffinity is set to HEADER_FIELD.
type: string
minimumRingSize:
description: |-
The minimum number of virtual nodes to use for the hash ring. Defaults to
1024. Larger ring sizes result in more granular load distributions. If the
number of hosts in the load balancing pool is larger than the ring size,
each host will be assigned a single virtual node.
type: integer

View File

@@ -0,0 +1,36 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha ConsistentHashLoadBalancerSettingsHttpCookie export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
name:
description: Name of the cookie.
type: string
path:
description: Path to set for the cookie.
type: string
ttl:
description: Lifetime of the cookie.
$ref: Duration.yaml

View File

@@ -0,0 +1,81 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha CorsPolicy export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
allowCredentials:
description: |-
In response to a preflight request, setting this to true indicates that
the actual request can include user credentials. This field translates to
the Access-Control-Allow-Credentials header. Default is false.
type: boolean
allowHeaders:
description: |-
Specifies the content for the Access-Control-Allow-Headers header.
type: array
items:
type: string
allowMethods:
description: |-
Specifies the content for the Access-Control-Allow-Methods header.
type: array
items:
type: string
allowOriginRegexes:
description: |-
Specifies a regular expression that matches allowed origins. For
more information about the regular expression syntax, see Syntax.
An origin is allowed if it matches either an item in allowOrigins
or an item in allowOriginRegexes.
type: array
items:
type: string
allowOrigins:
description: |-
Specifies the list of origins that is allowed to do CORS
requests. An origin is allowed if it matches either an item in
allowOrigins or an item in allowOriginRegexes.
type: array
items:
type: string
disabled:
description: |-
If true, the setting specifies the CORS policy is
disabled. The default value of false, which indicates that
the CORS policy is in effect.
type: boolean
exposeHeaders:
description: |-
Specifies the content for the Access-Control-Expose-
Headers header.
type: array
items:
type: string
maxAge:
description: |-
Specifies how long results of a preflight request can
be cached in seconds. This field translates to the
Access-Control-Max-Age header.
type: integer

View File

@@ -0,0 +1,56 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha CustomErrorResponsePolicy export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
errorResponseRules:
description: |-
Specifies rules for returning error responses. In a given policy, if you
specify rules for both a range of error codes as well as rules for
specific error codes then rules with specific error codes have a higher
priority. For example, assume that you configure a rule for 401 (Un-
authorized) code, and another for all 4 series error codes (4XX). If the
backend service returns a 401, then the rule for 401 will be applied.
However if the backend service returns a 403, the rule for 4xx takes
effect.
type: array
items:
$ref: CustomErrorResponsePolicyCustomErrorResponseRule.yaml
errorService:
description: |-
The full or partial URL to the BackendBucket resource that contains
the custom error content. Examples are: - https://www.googleapi s.com/
compute/v1/projects/project/global/backendBuckets/myBackendBucket -
compute/v1/projects/project/global/backendBuckets/myBackendBucket -
global/backendBuckets/myBackendBucket If errorService is not specified
at lower levels like pathMatcher, pathRule and routeRule, an
errorService specified at a higher level in the UrlMap will be used.
If UrlMap.defaultCustomErrorResponsePolicy contains one or more
errorResponseRules[], it must specify errorService. If load balancer
cannot reach the backendBucket, a simple Not Found Error will be
returned, with the original response code (or overrideResponseCode if
configured). errorService is not supported for internal or regional
HTTP/HTTPS load balancers.
type: string

View File

@@ -0,0 +1,56 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha CustomErrorResponsePolicyCustomErrorResponseRule export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
matchResponseCodes:
description: |-
Valid values include: - A number between 400 and 599: For example 401 or
503, in which case the load balancer applies the policy if the error code
exactly matches this value. - 5xx: Load Balancer will apply the policy if
the backend service responds with any response code in the range of 500 to
599. - 4xx: Load Balancer will apply the policy if the backend service
responds with any response code in the range of 400 to 499. Values must be
unique within matchResponseCodes and across all errorResponseRules of
CustomErrorResponsePolicy.
type: array
items:
type: string
overrideResponseCode:
description: |-
The HTTP status code returned with the response containing the custom
error content. If overrideResponseCode is not supplied, the same
response code returned by the original backend bucket or backend
service is returned to the client.
type: integer
path:
description: |-
The full path to a file within backendBucket . For example:
/errors/defaultError.html path must start with a leading slash. path
cannot have trailing slashes. If the file is not available in
backendBucket or the load balancer cannot reach the BackendBucket, a
simple Not Found Error is returned to the client. The value must be
from 1 to 1024 characters
type: string

View File

@@ -0,0 +1,57 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha CustomerEncryptionKey export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
kmsKeyName:
description: |-
The name of the encryption key that is stored in Google Cloud KMS.
type: string
kmsKeyServiceAccount:
description: |-
The service account being used for the encryption request for the given
KMS key. If absent, the Compute Engine default service account is used.
type: string
rawKey:
description: |-
Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648
base64 to either encrypt or decrypt this resource.
type: string
rsaEncryptedKey:
description: |-
Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-
supplied encryption key to either encrypt or decrypt this resource. The
key must meet the following requirements before you can provide it to
Compute Engine: - The key is wrapped using a RSA public key certificate
provided by Google. - After being wrapped, the key must be encoded in RFC
4648 base64 encoding. Gets the RSA public key certificate provided by
Google at: https://cloud- certs.storage.googleapis.com/google-cloud-csek-
ingress.pem
type: string
sha256:
description: |-
[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-
supplied encryption key that protects this resource.
type: string

View File

@@ -0,0 +1,40 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha DataValueListEntry export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
key:
description: |-
[Output Only] A key that provides more detail on the warning being
returned. For example, for warnings where there are no results in a list
request for a particular zone, this key might be scope and the key value
might be the zone name. Other examples might be a key indicating a
deprecated resource and a suggested replacement, or a warning about
invalid network settings (for example, if an instance attempts to perform
IP forwarding but is not enabled for IP forwarding).
type: string
value:
description: '[Output Only] A warning data value corresponding to the key.'
type: string

View File

@@ -0,0 +1,30 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha DisplayDevice export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
enableDisplay:
description: Defines whether the instance has Display enabled.
type: boolean

View File

@@ -0,0 +1,39 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha Duration export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
nanos:
description: |-
Span of time that's a fraction of a second at nanosecond resolution.
Durations less than one second are represented with a 0 `seconds` field
and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
type: integer
seconds:
description: |-
Span of time at a resolution of a second. Must be from 0 to
315,576,000,000 inclusive. Note: these bounds are computed from: 60
sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
type: integer

View File

@@ -0,0 +1,37 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha FileContentBuffer export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
content:
description: The raw content in the secure keys file.
type: string
fileType:
description: The file type of source file.
type: string
enum:
- BIN
- UNDEFINED
- X509

View File

@@ -0,0 +1,42 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha FirewallPolicy export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
packetMirroringRules:
description: |-
A list of packet mirroring rules that belong to this policy.
type: array
items:
$ref: FirewallPolicyRule.yaml
rules:
description: |-
A list of rules that belong to this policy. There must always be a
default rule (rule with priority 2147483647 and match "*"). If no
rules are provided when creating a firewall policy, a default rule
with action "allow" will be added.
type: array
items:
$ref: FirewallPolicyRule.yaml

View File

@@ -0,0 +1,47 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha FirewallPolicyAssociation export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
attachmentTarget:
description: The target that the firewall policy is attached to.
type: string
displayName:
description: |-
[Output Only] Deprecated, please use short name instead. The display name
of the firewall policy of the association.
type: string
name:
description: The name for an association.
type: string
priority:
description: |-
An integer indicating the priority of an association. The priority must be
a positive value between 1 and 2147483647. Firewall Policies are evaluated
from highest to lowest priority where 1 is the highest priority and
2147483647 is the lowest priority. The default value is `1000`. If two
associations have the same priority then lexicographical order on
association names is applied.
type: integer

View File

@@ -0,0 +1,140 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha FirewallPolicyRule export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
action:
description: |-
The Action to perform when the client connection triggers the rule. Valid
actions for firewall rules are: "allow", "deny",
"apply_security_profile_group" and "goto_next". Valid actions for packet
mirroring rules are: "mirror", "do_not_mirror" and "goto_next".
type: string
description:
description: An optional description for this resource.
type: string
direction:
description: The direction in which this rule applies.
type: string
enum:
- EGRESS
- INGRESS
disabled:
description: |-
Denotes whether the firewall policy rule is disabled. When set to true,
the firewall policy rule is not enforced and traffic behaves as if it did
not exist. If this is unspecified, the firewall policy rule will be
enabled.
type: boolean
enableLogging:
description: |-
Denotes whether to enable logging for a particular rule. If logging is
enabled, logs will be exported to the configured export destination in
Stackdriver. Logs may be exported to BigQuery or Pub/Sub.
type: boolean
match:
description: |-
A match condition that incoming traffic is evaluated against. If it
evaluates to true, the corresponding 'action' is enforced.
$ref: FirewallPolicyRuleMatcher.yaml
priority:
description: |-
An integer indicating the priority of a rule in the list. The priority
must be a positive value between 0 and 2147483647. Rules are evaluated
from highest to lowest priority where 0 is the highest priority and
2147483647 is the lowest priority.
type: integer
ruleName:
description: |-
An optional name for the rule. This field is not a unique identifier and
can be updated.
type: string
securityProfileGroup:
description: |-
A fully-qualified URL of a SecurityProfile resource instance. Example:
https://networksecurity.googleapis.com/v1/projects/{p
roject}/locations/{location}/securityProfileGroups/my-security-profile-
group Must be specified if action is one of 'apply_security_profile_group'
or 'mirror'. Cannot be specified for other actions.
type: string
targetForwardingRules:
description: |-
A list of forwarding rules to which this rule applies. This field allows
you to control which load balancers get this rule. For example, the
following are valid values: - https:
//www.googleapis.com/compute/v1/projects/project/global/forwardingRules/
forwardingRule - https://www.googleapis.com/compute/v1/projects/pro
ject/regions/region/forwardingRules/forwardingRule -
projects/project/global/ forwardingRules/forwardingRule -
projects/project/regions/region/forwardingRules/ forwardingRule
type: array
items:
type: string
targetResources:
description: |-
A list of network resource URLs to which this rule applies. This
field allows you to control which network's VMs get this rule. If
this field is left blank, all VMs within the organization will receive
the rule.
type: array
items:
type: string
targetSecureTags:
description: |-
A list of secure tags that controls which instances the firewall
rule applies to. If targetSecureTag are specified, then the
firewall rule applies only to instances in the VPC network that
have one of those EFFECTIVE secure tags, if all the
target_secure_tag are in INEFFECTIVE state, then this rule will be
ignored.targetSecureTag may not be set at the same time
astargetServiceAccounts. If neither targetServiceAccounts
nortargetSecureTag are specified, the firewall rule applies to all
instances on the specified network. Maximum number of target label
tags allowed is 256.
type: array
items:
$ref: FirewallPolicyRuleSecureTag.yaml
targetServiceAccounts:
description: |-
A list of service accounts indicating the sets of instances
that are applied with this rule.
type: array
items:
type: string
targetType:
description: |-
Target types of the firewall policy rule. Default value is
INSTANCES.
type: string
enum:
- INSTANCES
- INTERNAL_MANAGED_LB
tlsInspect:
description: |-
Boolean flag indicating if the traffic should be TLS
decrypted. Can be set only if action =
'apply_security_profile_group' and cannot be set for other
actions.
type: boolean

View File

@@ -0,0 +1,198 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha FirewallPolicyRuleMatcher export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
destAddressGroups:
description: |-
Address groups which should be matched against the traffic destination.
Maximum number of destination address groups is 10.
type: array
items:
type: string
destFqdns:
description: |-
Fully Qualified Domain Name (FQDN) which should be matched against
traffic destination. Maximum number of destination fqdn allowed is
100.
type: array
items:
type: string
destIpRanges:
description: |-
CIDR IP address range. Maximum number of destination CIDR IP
ranges allowed is 5000.
type: array
items:
type: string
destNetworkContext:
description: |-
Network context of the traffic destination. Allowed values
are: - UNSPECIFIED - INTERNET -
NON_INTERNET
type: string
enum:
- INTERNET
- INTRA_VPC
- NON_INTERNET
- UNSPECIFIED
- VPC_NETWORKS
destNetworkScope:
description: Network scope of the traffic destination.
type: string
enum:
- INTERNET
- INTRA_VPC
- NON_INTERNET
- UNSPECIFIED
- VPC_NETWORKS
destNetworkType:
description: |-
Network type of the traffic destination. Allowed values
type: string
enum:
- INTERNET
- INTRA_VPC
- NON_INTERNET
- UNSPECIFIED
- VPC_NETWORKS
destRegionCodes:
description: |-
Region codes whose IP addresses will be used to match for
destination of traffic. Should be specified as 2 letter
country code defined as per ISO 3166 alpha-2 country codes.
ex."US" Maximum number of dest region codes allowed is 5000.
type: array
items:
type: string
destThreatIntelligences:
description: |-
Names of Network Threat Intelligence lists. The IPs in
these lists will be matched against traffic destination.
type: array
items:
type: string
layer4Configs:
description: |-
Pairs of IP protocols and ports that the rule should
match.
type: array
items:
$ref: FirewallPolicyRuleMatcherLayer4Config.yaml
srcAddressGroups:
description: |-
Address groups which should be matched against the
traffic source. Maximum number of source address
groups is 10.
type: array
items:
type: string
srcFqdns:
description: |-
Fully Qualified Domain Name (FQDN) which
should be matched against traffic source.
Maximum number of source fqdn allowed is 100.
type: array
items:
type: string
srcIpRanges:
description: |-
CIDR IP address range. Maximum number of
source CIDR IP ranges allowed is 5000.
type: array
items:
type: string
srcNetworkContext:
description: |-
Network context of the traffic source.
Allowed values
type: string
enum:
- INTERNET
- INTRA_VPC
- NON_INTERNET
- UNSPECIFIED
- VPC_NETWORKS
srcNetworkScope:
description: |-
Network scope of the traffic source.
type: string
enum:
- INTERNET
- INTRA_VPC
- NON_INTERNET
- UNSPECIFIED
- VPC_NETWORKS
srcNetworkType:
description: |-
Network type of the traffic source.
Allowed values are: - UNSPECIFIED -
INTERNET - INTRA_VPC -
NON_INTERNET - VPC_NETWORKS
type: string
enum:
- INTERNET
- INTRA_VPC
- NON_INTERNET
- UNSPECIFIED
- VPC_NETWORKS
srcNetworks:
description: |-
Networks of the traffic source. It can
be either a full or partial url.
type: array
items:
type: string
srcRegionCodes:
description: |-
Region codes whose IP addresses will be
used to match for source of traffic.
Should be specified as 2 letter country
code defined as per ISO 3166 alpha-2
country codes. ex."US" Maximum number of
source region codes allowed is 5000.
type: array
items:
type: string
srcSecureTags:
description: |-
List of secure tag values, which should
be matched at the source of the traffic.
For INGRESS rule, if all the
srcSecureTag are INEFFECTIVE, and there
is no srcIpRange, this rule will be
ignored. Maximum number of source tag
values allowed is 256.
type: array
items:
$ref: FirewallPolicyRuleSecureTag.yaml
srcThreatIntelligences:
description: |-
Names of Network Threat Intelligence
lists. The IPs in these lists will be
matched against traffic source.
type: array
items:
type: string

View File

@@ -0,0 +1,43 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha FirewallPolicyRuleMatcherLayer4Config export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
ipProtocol:
description: |-
The IP protocol to which this rule applies. The protocol type is required
when creating a firewall rule. This value can either be one of the
following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp),
or the IP protocol number.
type: string
ports:
description: |-
An optional list of ports to which this rule applies. This field is only
applicable for UDP or TCP protocol. Each entry must be either an integer
or a range. If not specified, this rule applies to connections through any
port. Example inputs include: ["22"],["80","443"], and ["12345-12349"].
type: array
items:
type: string

View File

@@ -0,0 +1,30 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha FirewallPolicyRuleSecureTag export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
name:
description: Name of the secure tag, created with TagManager's TagValue API.
type: string

View File

@@ -0,0 +1,413 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha ForwardingRule export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
IPAddress:
description: |-
IP address for which this forwarding rule accepts traffic. When a client
sends traffic to this IP address, the forwarding rule directs the traffic
to the referenced target or backendService. While creating a forwarding
rule, specifying an IPAddress is required under the following
type: string
IPProtocol:
description: |-
The IP protocol to which this rule applies. For protocol forwarding, valid
options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP
protocols are different for different load balancing products as described
in [Load balancing features](https://cloud.google.com/load-
balancing/docs/features#protocol
s_from_the_load_balancer_to_the_backends).
type: string
enum:
- AH
- ALL
- ESP
- ICMP
- L3_DEFAULT
- SCTP
- TCP
- UDP
allPorts:
description: |-
The ports, portRange, and allPorts fields are mutually exclusive. Only
packets addressed to ports in the specified range will be forwarded to the
backends configured with this forwarding rule. The allPorts field has the
following limitations: - It requires that the forwarding rule IPProtocol
be TCP, UDP, SCTP, or L3_DEFAULT. - It's applicable only to the following
products: internal passthrough Network Load Balancers, backend service-
based external passthrough Network Load Balancers, and internal and
external protocol forwarding. - Set this field to true to allow packets
addressed to any port or packets lacking destination port information (for
example, UDP fragments after the first fragment) to be forwarded to the
backends configured with this forwarding rule. The L3_DEFAULT protocol
requires allPorts be set to true.
type: boolean
allowGlobalAccess:
description: |-
If set to true, clients can access the internal passthrough Network Load
Balancers, the regional internal Application Load Balancer, and the
regional internal proxy Network Load Balancer from all regions. If false,
only allows access from the local region the load balancer is located at.
Note that for INTERNAL_MANAGED forwarding rules, this field cannot be
changed after the forwarding rule is created.
type: boolean
allowPscGlobalAccess:
description: |-
This is used in PSC consumer ForwardingRule to control whether the PSC
endpoint can be accessed from another region.
type: boolean
allowPscPacketInjection:
description: |-
This is used in PSC consumer ForwardingRule to control whether the
producer is allowed to inject packets into the consumer's network. If set
to true, the target service attachment must have tunneling enabled and
TunnelingConfig.RoutingMode set to PACKET_INJECTION Non-PSC forwarding
rules should not use this field.
type: boolean
backendService:
description: |-
Identifies the backend service to which the forwarding rule sends traffic.
Required for internal and external passthrough Network Load Balancers;
must be omitted for all other load balancer types.
type: string
baseForwardingRule:
description: |-
[Output Only] The URL for the corresponding base forwarding rule. By base
forwarding rule, we mean the forwarding rule that has the same IP address,
protocol, and port settings with the current forwarding rule, but without
sourceIPRanges specified. Always empty if the current forwarding rule does
not have sourceIPRanges specified.
type: string
creationTimestamp:
description: '[Output Only] Creation timestamp in RFC3339 text format.'
type: string
description:
description: |-
An optional description of this resource. Provide this property when you
create the resource.
type: string
externalManagedBackendBucketMigrationState:
description: |-
Specifies the canary migration state for the backend buckets attached to
this forwarding rule. Possible values are PREPARE, TEST_BY_PERCENTAGE, and
TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to
EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be
changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed
to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used
to migrate traffic to backend buckets attached to this forwarding rule by
percentage using externalManagedBackendBucketMigrationTestingPercentage.
Rolling back a migration requires the states to be set in reverse order.
So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the
state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the
TEST_BY_PERCENTAGE state can be used to migrate some traffic back to
EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.
type: string
enum:
- PREPARE
- TEST_ALL_TRAFFIC
- TEST_BY_PERCENTAGE
externalManagedBackendBucketMigrationTestingPercentage:
description: |-
Determines the fraction of requests to backend buckets that should be
processed by the global external Application Load Balancer. The value of
this field must be in the range [0, 100]. This value can only be set if
the loadBalancingScheme in the BackendService is set to EXTERNAL (when
using the classic Application Load Balancer) and the migration state is
TEST_BY_PERCENTAGE.
type: number
fingerprint:
description: |-
Fingerprint of this resource. A hash of the contents stored in this
object. This field is used in optimistic locking. This field will be
ignored when inserting a ForwardingRule. Include the fingerprint in patch
request to ensure that you do not overwrite changes that were applied from
another concurrent request. To see the latest fingerprint, make a get()
request to retrieve a ForwardingRule.
type: string
ipCollection:
description: |-
Resource reference of a PublicDelegatedPrefix. The PDP must be a sub-PDP
in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode. Use one of the following
formats to specify a sub-PDP when creating an IPv6 NetLB forwarding rule
using BYOIP: Full resource URL, as in
https://www.googleapis.com/compute/v1/projects/project_id/regions/region
/publicDelegatedPrefixes/sub-pdp-name Partial URL, as in: -
projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name -
regions/region/publicDelegatedPrefixes/sub-pdp-name
type: string
ipVersion:
description: |-
The IP Version that will be used by this forwarding rule. Valid options
are IPV4 or IPV6.
type: string
enum:
- IPV4
- IPV6
- UNSPECIFIED_VERSION
isMirroringCollector:
description: |-
Indicates whether or not this load balancer can be used as a collector for
packet mirroring. To prevent mirroring loops, instances behind this load
balancer will not have their traffic mirrored even if a PacketMirroring
rule applies to them. This can only be set to true for load balancers that
have their loadBalancingScheme set to INTERNAL.
type: boolean
kind:
description: |-
[Output Only] Type of the resource. Always compute#forwardingRule for
forwarding rule resources.
type: string
labelFingerprint:
description: |-
A fingerprint for the labels being applied to this resource, which is
essentially a hash of the labels set used for optimistic locking. The
fingerprint is initially generated by Compute Engine and changes after
every request to modify or update labels. You must always provide an up-
to-date fingerprint hash in order to update or change labels, otherwise
the request will fail with error 412 conditionNotMet. To see the latest
fingerprint, make a get() request to retrieve a ForwardingRule.
type: string
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.
Label values may be empty.
$ref: LabelsValue.yaml
loadBalancingScheme:
description: |-
Specifies the forwarding rule type. For more information about forwarding
rules, refer to Forwarding rule concepts.
type: string
enum:
- EXTERNAL
- EXTERNAL_MANAGED
- INTERNAL
- INTERNAL_MANAGED
- INTERNAL_SELF_MANAGED
- INVALID
metadataFilters:
description: |-
Opaque filter criteria used by load balancer to restrict routing
configuration to a limited set of xDS compliant clients. In their xDS
requests to load balancer, xDS clients present node metadata. When there
is a match, the relevant configuration is made available to those proxies.
Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by
the ForwardingRule are not visible to those proxies. For each
metadataFilter in this list, if its filterMatchCriteria is set to
MATCH_ANY, at least one of the filterLabels must match the corresponding
label provided in the metadata. If its filterMatchCriteria is set to
MATCH_ALL, then all of its filterLabels must match with corresponding
labels provided in the metadata. If multiple metadataFilters are
specified, all of them need to be satisfied in order to be considered a
match. metadataFilters specified here will be applifed before those
specified in the UrlMap that this ForwardingRule references.
metadataFilters only applies to Loadbalancers that have their
loadBalancingScheme set to INTERNAL_SELF_MANAGED.
type: array
items:
$ref: MetadataFilter.yaml
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
RFC1035. 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. For Private Service Connect
forwarding rules that forward traffic to Google APIs, the forwarding
rule name must be a 1-20 characters string with lowercase letters and
numbers and must start with a letter.
type: string
network:
description: |-
This field is not used for global external load balancing. For
internal passthrough Network Load Balancers, this field identifies the
network that the load balanced IP should belong to for this forwarding
rule. If the subnetwork is specified, the network of the subnetwork
will be used. If neither subnetwork nor this field is specified, the
default network will be used. For Private Service Connect forwarding
rules that forward traffic to Google APIs, a network must be provided.
type: string
networkTier:
description: |-
This signifies the networking tier used for configuring this load
balancer and can only take the following values: PREMIUM, STANDARD.
For regional ForwardingRule, the valid values are PREMIUM and
STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If
this field is not specified, it is assumed to be PREMIUM. If IPAddress
is specified, this value must be equal to the networkTier of the
Address.
type: string
enum:
- FIXED_STANDARD
- PREMIUM
- SELECT
- STANDARD
- STANDARD_OVERRIDES_FIXED_STANDARD
noAutomateDnsZone:
description: |-
This is used in PSC consumer ForwardingRule to control whether it
should try to auto-generate a DNS zone or not. Non-PSC forwarding
rules do not use this field. Once set, this field is not mutable.
type: boolean
portRange:
description: |-
The ports, portRange, and allPorts fields are mutually exclusive. Only
packets addressed to ports in the specified range will be forwarded to
the backends configured with this forwarding rule. The portRange field
has the following limitations: - It requires that the forwarding rule
IPProtocol be TCP, UDP, or SCTP, and - It's applicable only to the
following products: external passthrough Network Load Balancers,
internal and external proxy Network Load Balancers, internal and
external Application Load Balancers, external protocol forwarding, and
Classic VPN. - Some products have restrictions on what ports can be
used. See port specifications for details. For external forwarding
rules, two or more forwarding rules cannot use the same [IPAddress,
IPProtocol] pair, and cannot have overlapping portRanges. For internal
forwarding rules within the same VPC network, two or more forwarding
rules cannot use the same [IPAddress, IPProtocol] pair, and cannot
have overlapping portRanges. @pattern: \\d+(?:-\\d+)?
type: string
ports:
description: |-
The ports, portRange, and allPorts fields are mutually exclusive. Only
packets addressed to ports in the specified range will be forwarded to
the backends configured with this forwarding rule. The ports field has
the following limitations: - It requires that the forwarding rule
IPProtocol be TCP, UDP, or SCTP, and - It's applicable only to the
following products: internal passthrough Network Load Balancers,
backend service-based external passthrough Network Load Balancers, and
internal protocol forwarding. - You can specify a list of up to five
ports by number, separated by commas. The ports can be contiguous or
discontiguous. For external forwarding rules, two or more forwarding
rules cannot use the same [IPAddress, IPProtocol] pair if they share
at least one port number. For internal forwarding rules within the
same VPC network, two or more forwarding rules cannot use the same
[IPAddress, IPProtocol] pair if they share at least one port number.
@pattern: \\d+(?:-\\d+)?
type: array
items:
type: string
pscConnectionId:
description: |-
[Output Only] The PSC connection id of the PSC forwarding rule.
type: integer
pscConnectionStatus:
description: A PscConnectionStatusValueValuesEnum attribute.
type: string
enum:
- ACCEPTED
- CLOSED
- NEEDS_ATTENTION
- PENDING
- REJECTED
- STATUS_UNSPECIFIED
region:
description: |-
[Output Only] URL of the region where the regional forwarding rule
resides. This field is not applicable to global forwarding rules.
You must specify this field as part of the HTTP request URL. It is
not settable as a field in the request body.
type: string
selfLink:
description: '[Output Only] Server-defined URL for the resource.'
type: string
selfLinkWithId:
description: |-
[Output Only] Server-defined URL for this resource with the
resource id.
type: string
serviceDirectoryRegistrations:
description: |-
Service Directory resources to register this forwarding rule with.
Currently, only supports a single Service Directory resource.
type: array
items:
$ref: ForwardingRuleServiceDirectoryRegistration.yaml
serviceLabel:
description: |-
An optional prefix to the service name for this forwarding
rule. If specified, the prefix is the first label of the fully
qualified service name. The label must be 1-63 characters
long, and comply with RFC1035. Specifically, the label 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. This field is only used for
internal load balancing.
type: string
serviceName:
description: |-
[Output Only] The internal fully qualified service name for
this forwarding rule. This field is only used for internal
load balancing.
type: string
sourceIpRanges:
description: |-
If not empty, this forwarding rule will only forward the
traffic when the source IP address matches one of the IP
addresses or CIDR ranges set here. Note that a forwarding rule
can only have up to 64 source IP ranges, and this field can
only be used with a regional forwarding rule whose scheme is
EXTERNAL. Each source_ip_range entry should be either an IP
address (for example, 1.2.3.4) or a CIDR range (for example,
1.2.3.0/24).
type: array
items:
type: string
subnetwork:
description: |-
This field identifies the subnetwork that the load
balanced IP should belong to for this forwarding rule,
used with internal load balancers and external passthrough
Network Load Balancers with IPv6. If the network specified
is in auto subnet mode, this field is optional. However, a
subnetwork must be specified if the network is in custom
subnet mode or when creating external forwarding rule with
IPv6.
type: string
target:
description: |-
The URL of the target resource to receive the matched
traffic. For regional forwarding rules, this target must
be in the same region as the forwarding rule. For global
forwarding rules, this target must be a global load
balancing resource. The forwarded traffic must be of a
type appropriate to the target object. - For load
balancers, see the "Target" column in [Port
specifications](https://cloud.google.com/load-
balancing/docs/forwarding-rule-
concepts#ip_address_specifications). - For Private Service
Connect forwarding rules that forward traffic to Google
APIs, provide the name of a supported Google API bundle: -
vpc-sc - APIs that support VPC Service Controls. - all-
apis - All supported Google APIs. - For Private Service
Connect forwarding rules that forward traffic to managed
services, the target must be a service attachment. The
target is not mutable once set as a service attachment.
type: string

View File

@@ -0,0 +1,42 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha ForwardingRuleServiceDirectoryRegistration export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
namespace:
description: |-
Service Directory namespace to register the forwarding rule under.
type: string
service:
description: |-
Service Directory service to register the forwarding rule under.
type: string
serviceDirectoryRegion:
description: |-
[Optional] Service Directory region to register this global forwarding
rule under. Default to "us-central1". Only used for PSC for Google APIs.
All PSC for Google APIs forwarding rules on the same network should use
the same Service Directory region.
type: string

View File

@@ -0,0 +1,36 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha GrpcServiceConfig export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
callCredentials:
description: The call credentials to access the SDS server.
$ref: CallCredentials.yaml
channelCredentials:
description: The channel credentials to access the SDS server.
$ref: ChannelCredentials.yaml
targetUri:
description: The target URI of the SDS server.
type: string

View File

@@ -0,0 +1,48 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha GuestOsFeature export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
type:
description: |-
The ID of a supported feature. Read Enabling guest operating system
features to see a list of available options.
type: string
enum:
- BARE_METAL_LINUX_COMPATIBLE
- FEATURE_TYPE_UNSPECIFIED
- GVNIC
- MULTI_IP_SUBNET
- SECURE_BOOT
- SEV_CAPABLE
- UEFI_COMPATIBLE
- VIRTIO_SCSI_MULTIQUEUE
- WINDOWS
- SEV_LIVE_MIGRATABLE
- SEV_SNP_CAPABLE
- SNP_SVSM_CAPABLE
- SEV_LIVE_MIGRATABLE_V2
- IDPF
- TDX_CAPABLE

View File

@@ -0,0 +1,51 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha HaController export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
backendServices:
description: |-
Advanced configuration option. If specified, these Backend Services need
to be pre-created and configured as managed.
type: array
items:
type: string
description:
description: |-
An optional description of this resource. Provide this property when
you create the resource.
type: string
failoverInitiation:
description: Indicates how failover should be initiated.
type: string
enum:
- FAILOVER_INITIATION_UNSPECIFIED
- MANUAL_ONLY
instanceName:
description: |-
Name of the instance that HaController is in charge of. If not
specified the HaController's resource name will be used instead. 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.
type: string
networkingAutoConfiguration:
description: |-
Basic networking configuration. Required backend services and
forwarding rules will be automatically created with default
parameters.
$ref: HaControllerNetworkingAutoConfiguration.yaml
secondaryZoneCapacity:
description: Indicates the capacity guarantees in the secondary zone.
type: string
enum:
- BEST_EFFORT
- SECONDARY_ZONE_CAPACITY_UNSPECIFIED
zoneConfigurations:
description: 'Map of zone configurations Key: name of the zone'
$ref: ZoneConfigurationsValue.yaml

View File

@@ -0,0 +1,10 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha HaControllerNetworkingAutoConfiguration export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
internal:
description: Internal networking configuration
$ref: HaControllerNetworkingAutoConfigurationInternal.yaml

View File

@@ -0,0 +1,24 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha HaControllerNetworkingAutoConfigurationInternal export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
ipAddress:
description: |-
IP addresses will be automatically allocated according to StackType if not
provided.
type: string
ipv6Address:
description: A string attribute.
type: string
stackType:
description: |-
Determine which IP addresses to automatically create. Field and option
naming consistent with NetworkInterface configuration on Instances.
type: string
enum:
- IPV4_IPV6
- IPV4_ONLY
- IPV6_ONLY

View File

@@ -0,0 +1,18 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha HaControllerZoneConfiguration export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
nodeAffinities:
description: |-
A set of node affinity configurations. Refer toConfiguring node affinity
for more information. Overrides reservationAffinity.
type: array
items:
$ref: HaControllerZoneConfigurationNodeAffinity.yaml
reservationAffinity:
description: |-
Specifies the reservations that the instance can consume from.
$ref: HaControllerZoneConfigurationReservationAffinity.yaml

View File

@@ -0,0 +1,24 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha HaControllerZoneConfigurationNodeAffinity export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
key:
description: Corresponds to the label key of Node resource.
type: string
operator:
description: |-
Defines the operation of node selection. Valid operators areIN for
affinity and NOT_IN for anti-affinity.
type: string
enum:
- IN
- NOT_IN
- OPERATOR_UNSPECIFIED
values:
description: Corresponds to the label values of Node resource.
type: array
items:
type: string

View File

@@ -0,0 +1,35 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha HaControllerZoneConfigurationReservationAffinity export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
consumeReservationType:
description: |-
Specifies the type of reservation from which this instance can consume
resources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or
NO_RESERVATION. See Consuming reserved instances for examples.
type: string
enum:
- ANY_RESERVATION
- NO_RESERVATION
- SPECIFIC_RESERVATION
- SPECIFIC_THEN_ANY_RESERVATION
- SPECIFIC_THEN_NO_RESERVATION
- UNSPECIFIED
key:
description: |-
Corresponds to the label key of a reservation resource. To target
aSPECIFIC_RESERVATION by name, specify$$UNIVERSE_DOMAIN$$/reservation-name as
the key and specify the name of your reservation as its value.
type: string
values:
description: |-
Corresponds to the label values of a reservation resource. This can be
either a name to a reservation in the same project or "projects/different-
project/reservations/some-reservation-name" to target a shared reservation
in the same zone but in a different project.
type: array
items:
type: string

View File

@@ -0,0 +1,48 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha HostRule export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
description:
description: |-
An optional description of this resource. Provide this property when you
create the resource.
type: string
hosts:
description: |-
The list of host patterns to match. They must be valid hostnames with
optional port numbers in the format host:port. * matches any string of
([a-z0-9-.]*). In that case, * must be the first character, and if
followed by anything, the immediate following character must be either -
or .. * based matching is not supported when the URL map is bound to a
target gRPC proxy that has the validateForProxyless field set to true.
type: array
items:
type: string
pathMatcher:
description: |-
The name of the PathMatcher to use to match the path portion of the
URL if the hostRule matches the URL's host portion.
type: string

View File

@@ -0,0 +1,41 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha HttpFaultAbort export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
httpStatus:
description: |-
The HTTP status code used to abort the request. The value must be from 200
to 599 inclusive. For gRPC protocol, the gRPC status code is mapped to
HTTP status code according to this mapping table. HTTP status 200 is
mapped to gRPC status UNKNOWN. Injecting an OK status is currently not
supported by Traffic Director.
type: integer
percentage:
description: |-
The percentage of traffic for connections, operations, or requests that is
aborted as part of fault injection. The value must be from 0.0 to 100.0
inclusive.
type: number

View File

@@ -0,0 +1,36 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha HttpFaultDelay export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
fixedDelay:
description: Specifies the value of the fixed delay interval.
$ref: Duration.yaml
percentage:
description: |-
The percentage of traffic for connections, operations, or requests for
which a delay is introduced as part of fault injection. The value must be
from 0.0 to 100.0 inclusive.
type: number

View File

@@ -0,0 +1,37 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha HttpFaultInjection export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
abort:
description: |-
The specification for how client requests are aborted as part of fault
injection.
$ref: HttpFaultAbort.yaml
delay:
description: |-
The specification for how client requests are delayed as part of fault
injection, before being sent to a backend service.
$ref: HttpFaultDelay.yaml

View File

@@ -0,0 +1,43 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha HttpFilterConfig export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
config:
description: |-
The configuration needed to enable the networkservices.HttpFilter
resource. The configuration must be YAML formatted and only contain fields
defined in the protobuf identified in configTypeUrl
type: string
configTypeUrl:
description: |-
The fully qualified versioned proto3 type url of the protobuf that the
filter expects for its contextual settings, for
type: string
filterName:
description: |-
Name of the networkservices.HttpFilter resource this configuration belongs
to. This name must be known to the xDS client.
type: string

View File

@@ -0,0 +1,56 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha HttpHeaderAction export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
requestHeadersToAdd:
description: |-
Headers to add to a matching request before forwarding the request to the
backendService.
type: array
items:
$ref: HttpHeaderOption.yaml
requestHeadersToRemove:
description: |-
A list of header names for headers that need to be removed from the
request before forwarding the request to the backendService.
type: array
items:
type: string
responseHeadersToAdd:
description: |-
Headers to add the response before sending the response back to
the client.
type: array
items:
$ref: HttpHeaderOption.yaml
responseHeadersToRemove:
description: |-
A list of header names for headers that need to be removed
from the response before sending the response back to the
client.
type: array
items:
type: string

View File

@@ -0,0 +1,90 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha HttpHeaderMatch export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
exactMatch:
description: |-
The value should exactly match contents of exactMatch. Only one of
exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or
rangeMatch must be set.
type: string
headerName:
description: |-
The name of the HTTP header to match. For matching against the HTTP
request's authority, use a headerMatch with the header name ":authority".
For matching a request's method, use the headerName ":method". When the
URL map is bound to a target gRPC proxy that has the validateForProxyless
field set to true, only non-binary user-specified custom metadata and the
`content-type` header are supported. The following transport-level headers
cannot be used in header matching
type: string
invertMatch:
description: |-
If set to false, the headerMatch is considered a match if the preceding
match criteria are met. If set to true, the headerMatch is considered a
match if the preceding match criteria are NOT met. The default setting is
false.
type: boolean
prefixMatch:
description: |-
The value of the header must start with the contents of prefixMatch. Only
one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or
rangeMatch must be set.
type: string
presentMatch:
description: |-
A header with the contents of headerName must exist. The match takes place
whether or not the request's header has a value. Only one of exactMatch,
prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be
set.
type: boolean
rangeMatch:
description: |-
The header value must be an integer and its value must be in the range
specified in rangeMatch. If the header does not contain an integer, number
or is empty, the match fails. For example for a range [-5, 0] - -3 will
match. - 0 will not match. - 0.25 will not match. - -3someString will not
match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch,
presentMatch or rangeMatch must be set. rangeMatch is not supported for
load balancers that have loadBalancingScheme set to EXTERNAL.
$ref: Int64RangeMatch.yaml
regexMatch:
description: |-
The value of the header must match the regular expression specified in
regexMatch. For more information about regular expression syntax, see
Syntax. For matching against a port specified in the HTTP request, use a
headerMatch with headerName set to PORT and a regular expression that
satisfies the RFC2616 Host header's port specifier. Only one of
exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or
rangeMatch must be set. regexMatch only applies to load balancers that
have loadBalancingScheme set to INTERNAL_SELF_MANAGED.
type: string
suffixMatch:
description: |-
The value of the header must end with the contents of suffixMatch. Only
one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or
rangeMatch must be set.
type: string

View File

@@ -0,0 +1,39 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha HttpHeaderOption export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
headerName:
description: The name of the header.
type: string
headerValue:
description: The value of the header to add.
type: string
replace:
description: |-
If false, headerValue is appended to any values that already exist for the
header. If true, headerValue is set for the header, discarding any values
that were set for that header. The default value is false.
type: boolean

View File

@@ -0,0 +1,52 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha HttpQueryParameterMatch export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
exactMatch:
description: |-
The queryParameterMatch matches if the value of the parameter exactly
matches the contents of exactMatch. Only one of presentMatch, exactMatch,
or regexMatch must be set.
type: string
name:
description: |-
The name of the query parameter to match. The query parameter must exist
in the request, in the absence of which the request match fails.
type: string
presentMatch:
description: |-
Specifies that the queryParameterMatch matches if the request contains the
query parameter, irrespective of whether the parameter has a value or not.
Only one of presentMatch, exactMatch, or regexMatch must be set.
type: boolean
regexMatch:
description: |-
The queryParameterMatch matches if the value of the parameter matches the
regular expression specified by regexMatch. For more information about
regular expression syntax, see Syntax. Only one of presentMatch,
exactMatch, or regexMatch must be set. regexMatch only applies when the
loadBalancingScheme is set to INTERNAL_SELF_MANAGED.
type: string

View File

@@ -0,0 +1,78 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha HttpRedirectAction export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
hostRedirect:
description: |-
The host that is used in the redirect response instead of the one that was
supplied in the request. The value must be from 1 to 255 characters.
type: string
httpsRedirect:
description: |-
If set to true, the URL scheme in the redirected request is set to HTTPS.
If set to false, the URL scheme of the redirected request remains the same
as that of the request. This must only be set for URL maps used in
TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.
The default is set to false.
type: boolean
pathRedirect:
description: |-
The path that is used in the redirect response instead of the one that was
supplied in the request. pathRedirect cannot be supplied together with
prefixRedirect. Supply one alone or neither. If neither is supplied, the
path of the original request is used for the redirect. The value must be
from 1 to 1024 characters.
type: string
prefixRedirect:
description: |-
The prefix that replaces the prefixMatch specified in the
HttpRouteRuleMatch, retaining the remaining portion of the URL before
redirecting the request. prefixRedirect cannot be supplied together with
pathRedirect. Supply one alone or neither. If neither is supplied, the
path of the original request is used for the redirect. The value must be
from 1 to 1024 characters.
type: string
redirectResponseCode:
description: |-
The HTTP Status code to use for this RedirectAction. Supported values are:
- MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to
301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to
303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the
request method is retained. - PERMANENT_REDIRECT, which corresponds to
308. In this case, the request method is retained.
type: string
enum:
- FOUND
- MOVED_PERMANENTLY_DEFAULT
- PERMANENT_REDIRECT
- SEE_OTHER
- TEMPORARY_REDIRECT
stripQuery:
description: |-
If set to true, any accompanying query portion of the original URL is
removed before redirecting the request. If set to false, the query portion
of the original URL is retained. The default is set to false.
type: boolean

View File

@@ -0,0 +1,60 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha HttpRetryPolicy export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
numRetries:
description: |-
Specifies the allowed number retries. This number must be > 0. If not
specified, defaults to 1.
type: integer
perTryTimeout:
description: |-
Specifies a non-zero timeout per retry attempt. If not specified, will use
the timeout set in the HttpRouteAction field. If timeout in the
HttpRouteAction field is not set, this field uses the largest timeout
among all backend services associated with the route. Not supported when
the URL map is bound to a target gRPC proxy that has the
validateForProxyless field set to true.
$ref: Duration.yaml
retryConditions:
description: |-
Specifies one or more conditions when this retry policy applies. Valid
values are: - 5xx: retry is attempted if the instance or endpoint responds
with any 5xx response code, or if the instance or endpoint does not
respond at all. For example, disconnects, reset, read timeout, connection
failure, and refused streams. - gateway-error: Similar to 5xx, but only
applies to response codes 502, 503 or 504. - connect-failure: a retry is
attempted on failures connecting to the instance or endpoint. For example,
connection timeouts. - retriable-4xx: a retry is attempted if the instance
or endpoint responds with a 4xx response code. The only error that you can
retry is error code 409. - refused-stream: a retry is attempted if the
instance or endpoint resets the stream with a REFUSED_STREAM error code.
This reset type indicates that it is safe to retry. - cancelled: a retry
is attempted if the gRPC status code in the response header is set to
cancelled. - deadline-
type: array
items:
type: string

View File

@@ -0,0 +1,104 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha HttpRouteAction export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
corsPolicy:
description: |-
The specification for allowing client-side cross-origin requests. For more
information about the W3C recommendation for cross- origin resource
sharing (CORS), see Fetch API Living Standard. Not supported when the URL
map is bound to a target gRPC proxy.
$ref: CorsPolicy.yaml
faultInjectionPolicy:
description: |-
The specification for fault injection introduced into traffic to test the
resiliency of clients to backend service failure. As part of fault
injection, when clients send requests to a backend service, delays can be
introduced by a load balancer on a percentage of requests before sending
those requests to the backend service. Similarly requests from clients can
be aborted by the load balancer for a percentage of requests. timeout and
retry_policy is ignored by clients that are configured with a
fault_injection_policy if: 1. The traffic is generated by fault injection
AND 2. The fault injection is not a delay fault injection. Fault injection
is not supported with the global external HTTP(S) load balancer (classic).
To see which load balancers support fault injection, see Load balancing:
Routing and traffic management features.
$ref: HttpFaultInjection.yaml
maxStreamDuration:
description: |-
Specifies the maximum duration (timeout) for streams on the selected
route. Unlike the timeout field where the timeout duration starts from the
time the request has been fully processed (known as *end-of-stream*), the
duration in this field is computed from the beginning of the stream until
the response has been processed, including all retries. A stream that does
not complete in this duration is closed. If not specified, this field uses
the maximum maxStreamDuration value among all backend services associated
with the route. This field is only allowed if the Url map is used with
backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.
$ref: Duration.yaml
requestMirrorPolicy:
description: |-
Specifies the policy on how requests intended for the route's backends are
shadowed to a separate mirrored backend service. The load balancer does
not wait for responses from the shadow service. Before sending traffic to
the shadow service, the host / authority header is suffixed with -shadow.
Not supported when the URL map is bound to a target gRPC proxy that has
the validateForProxyless field set to true.
$ref: RequestMirrorPolicy.yaml
retryPolicy:
description: Specifies the retry policy associated with this route.
$ref: HttpRetryPolicy.yaml
timeout:
description: |-
Specifies the timeout for the selected route. Timeout is computed from the
time the request has been fully processed (known as *end-of- stream*) up
until the response has been processed. Timeout includes all retries. If
not specified, this field uses the largest timeout among all backend
services associated with the route. Not supported when the URL map is
bound to a target gRPC proxy that has validateForProxyless field set to
true.
$ref: Duration.yaml
urlRewrite:
description: |-
The spec to modify the URL of the request, before forwarding the request
to the matched service. urlRewrite is the only action supported in UrlMaps
for external HTTP(S) load balancers. Not supported when the URL map is
bound to a target gRPC proxy that has the validateForProxyless field set
to true.
$ref: UrlRewrite.yaml
weightedBackendServices:
description: |-
A list of weighted backend services to send traffic to when a route match
occurs. The weights determine the fraction of traffic that flows to their
corresponding backend service. If all traffic needs to go to a single
backend service, there must be one weightedBackendService with weight set
to a non-zero number. After a backend service is identified and before
forwarding the request to the backend service, advanced routing actions
such as URL rewrites and header transformations are applied depending on
additional settings specified in this HttpRouteAction.
type: array
items:
$ref: WeightedBackendService.yaml

View File

@@ -0,0 +1,155 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha HttpRouteRule export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
customErrorResponsePolicy:
description: |-
customErrorResponsePolicy specifies how the Load Balancer returns error
responses when BackendServiceor BackendBucket responds with an error. If a
policy for an error code is not configured for the RouteRule, a policy for
the error code configured in pathMatcher.defaultCustomErrorResponsePolicy
is applied. If one is not specified in
pathMatcher.defaultCustomErrorResponsePolicy, the policy configured in
UrlMap.defaultCustomErrorResponsePolicy takes effect. For example,
consider a UrlMap with the following configuration: -
UrlMap.defaultCustomErrorResponsePolicy are configured with policies for
5xx and 4xx errors - A RouteRule for /coming_soon/ is configured for the
error code 404. If the request is for www.myotherdomain.com and a 404 is
encountered, the policy under UrlMap.defaultCustomErrorResponsePolicy
takes effect. If a 404 response is encountered for the request
www.example.com/current_events/, the pathMatcher's policy takes effect. If
however, the request for www.example.com/coming_soon/ encounters a 404,
the policy in RouteRule.customErrorResponsePolicy takes effect. If any of
the requests in this example encounter a 500 error code, the policy at
UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in
conjunction with routeRules.routeAction.retryPolicy, retries take
precedence. Only once all retries are exhausted, the
customErrorResponsePolicy is applied. While attempting a retry, if load
balancer is successful in reaching the service, the
customErrorResponsePolicy is ignored and the response from the service is
returned to the client. customErrorResponsePolicy is supported only for
Global External HTTP(S) load balancing.
$ref: CustomErrorResponsePolicy.yaml
description:
description: |-
The short description conveying the intent of this routeRule. The
description can have a maximum length of 1024 characters.
type: string
headerAction:
description: |-
Specifies changes to request and response headers that need to take effect
for the selected backendService. The headerAction value specified here is
applied before the matching pathMatchers[].headerAction and after
pathMatchers[].routeRules[].routeA
ction.weightedBackendService.backendServiceWeightAction[].headerAction
HeaderAction is not supported for load balancers that have their
loadBalancingScheme set to EXTERNAL. Not supported when the URL map is
bound to a target gRPC proxy that has validateForProxyless field set to
true.
$ref: HttpHeaderAction.yaml
httpFilterConfigs:
description: |-
Outbound route specific configuration for networkservices.HttpFilter
resources enabled by Traffic Director. httpFilterConfigs only applies for
load balancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See
ForwardingRule for more details. Not supported when the URL map is bound
to a target gRPC proxy that has validateForProxyless field set to true.
type: array
items:
$ref: HttpFilterConfig.yaml
httpFilterMetadata:
description: |-
Outbound route specific metadata supplied to
networkservices.HttpFilter resources enabled by Traffic Director.
httpFilterMetadata only applies for load balancers with
loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule
for more details. The only configTypeUrl supported is
type.googleapis.com/google.protobuf.Struct Not supported when the URL
map is bound to a target gRPC proxy that has validateForProxyless
field set to true.
type: array
items:
$ref: HttpFilterConfig.yaml
matchRules:
description: |-
The list of criteria for matching attributes of a request to this
routeRule. This list has OR semantics: the request matches this
routeRule when any of the matchRules are satisfied. However
predicates within a given matchRule have AND semantics. All
predicates within a matchRule must match for the request to match
the rule.
type: array
items:
$ref: HttpRouteRuleMatch.yaml
priority:
description: |-
For routeRules within a given pathMatcher, priority determines
the order in which a load balancer interprets routeRules.
RouteRules are evaluated in order of priority, from the lowest
to highest number. The priority of a rule decreases as its
number increases (1, 2, 3, N+1). The first rule that matches
the request is applied. You cannot configure two or more
routeRules with the same priority. Priority for each rule must
be set to a number from 0 to 2147483647 inclusive. Priority
numbers can have gaps, which enable you to add or remove rules
in the future without affecting the rest of the rules. For
example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of
priority numbers to which you could add rules numbered from 6
to 8, 10 to 11, and 13 to 15 in the future without any impact
on existing rules.
type: integer
routeAction:
description: |-
In response to a matching matchRule, the load balancer
performs advanced routing actions, such as URL rewrites and
header transformations, before forwarding the request to the
selected backend. If routeAction specifies any
weightedBackendServices, service must not be set. Conversely
if service is set, routeAction cannot contain any
weightedBackendServices. Only one of urlRedirect, service or
routeAction.weightedBackendService must be set. URL maps for
Classic external HTTP(S) load balancers only support the
urlRewrite action within a route rule's routeAction.
$ref: HttpRouteAction.yaml
service:
description: |-
The full or partial URL of the backend service resource to
which traffic is directed if this rule is matched. If
routeAction is also specified, advanced routing actions, such
as URL rewrites, take effect before sending the request to the
backend. However, if service is specified, routeAction cannot
contain any weightedBackendServices. Conversely, if
routeAction specifies any weightedBackendServices, service
must not be specified. Only one of urlRedirect, service or
routeAction.weightedBackendService must be set.
type: string
urlRedirect:
description: |-
When this rule is matched, the request is redirected to a URL
specified by urlRedirect. If urlRedirect is specified, service
or routeAction must not be set. Not supported when the URL map
is bound to a target gRPC proxy.
$ref: HttpRedirectAction.yaml

View File

@@ -0,0 +1,107 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha HttpRouteRuleMatch export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
fullPathMatch:
description: |-
For satisfying the matchRule condition, the path of the request must
exactly match the value specified in fullPathMatch after removing any
query parameters and anchor that may be part of the original URL.
fullPathMatch must be from 1 to 1024 characters. Only one of prefixMatch,
fullPathMatch or regexMatch must be specified.
type: string
headerMatches:
description: |-
Specifies a list of header match criteria, all of which must match
corresponding headers in the request.
type: array
items:
$ref: HttpHeaderMatch.yaml
ignoreCase:
description: |-
Specifies that prefixMatch and fullPathMatch matches are case
sensitive. The default value is false. ignoreCase must not be used
with regexMatch. Not supported when the URL map is bound to a target
gRPC proxy.
type: boolean
metadataFilters:
description: |-
Opaque filter criteria used by the load balancer to restrict routing
configuration to a limited set of xDS compliant clients. In their xDS
requests to the load balancer, xDS clients present node metadata. When
there is a match, the relevant routing configuration is made available
to those proxies. For each metadataFilter in this list, if its
filterMatchCriteria is set to MATCH_ANY, at least one of the
filterLabels must match the corresponding label provided in the
metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of
its filterLabels must match with corresponding labels provided in the
metadata. If multiple metadata filters are specified, all of them need
to be satisfied in order to be considered a match. metadataFilters
specified here is applied after those specified in ForwardingRule that
refers to the UrlMap this HttpRouteRuleMatch belongs to.
metadataFilters only applies to load balancers that have
loadBalancingScheme set to INTERNAL_SELF_MANAGED. Not supported when
the URL map is bound to a target gRPC proxy that has
validateForProxyless field set to true.
type: array
items:
$ref: MetadataFilter.yaml
pathTemplateMatch:
description: |-
If specified, the route is a pattern match expression that must
match the :path header once the query string is removed. A pattern
match allows you to match - The value must be between 1 and 1024
characters - The pattern must start with a leading slash ("/") -
There may be no more than 5 operators in pattern Precisely one of
prefix_match, full_path_match, regex_match or path_template_match
must be set.
type: string
prefixMatch:
description: |-
For satisfying the matchRule condition, the request's path must
begin with the specified prefixMatch. prefixMatch must begin with
a /. The value must be from 1 to 1024 characters. Only one of
prefixMatch, fullPathMatch or regexMatch must be specified.
type: string
queryParameterMatches:
description: |-
Specifies a list of query parameter match criteria, all of which
must match corresponding query parameters in the request. Not
supported when the URL map is bound to a target gRPC proxy.
type: array
items:
$ref: HttpQueryParameterMatch.yaml
regexMatch:
description: |-
For satisfying the matchRule condition, the path of the
request must satisfy the regular expression specified in
regexMatch after removing any query parameters and anchor
supplied with the original URL. For more information about
regular expression syntax, see Syntax. Only one of
prefixMatch, fullPathMatch or regexMatch must be specified.
regexMatch only applies to load balancers that have
loadBalancingScheme set to INTERNAL_SELF_MANAGED.
type: string

View File

@@ -0,0 +1,45 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha InitialStateConfig export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
dbs:
description: The Key Database (db).
type: array
items:
$ref: FileContentBuffer.yaml
dbxs:
description: The forbidden key database (dbx).
type: array
items:
$ref: FileContentBuffer.yaml
keks:
description: The Key Exchange Key (KEK).
type: array
items:
$ref: FileContentBuffer.yaml
pk:
description: The Platform Key (PK).
$ref: FileContentBuffer.yaml

View File

@@ -0,0 +1,357 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha Instance export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
advancedMachineFeatures:
description: Controls for advanced machine-related behavior features.
$ref: AdvancedMachineFeatures.yaml
canIpForward:
description: |-
Allows this instance to send and receive packets with non- matching
destination or source IPs. This is required if you plan to use this
instance to forward routes. For more information, see Enabling IP
Forwarding.
type: boolean
confidentialInstanceConfig:
description: A ConfidentialInstanceConfig attribute.
$ref: ConfidentialInstanceConfig.yaml
cpuPlatform:
description: '[Output Only] The CPU platform used by this instance.'
type: string
creationTimestamp:
description: '[Output Only] Creation timestamp in RFC3339 text format.'
type: string
deletionProtection:
description: Whether the resource should be protected against deletion.
type: boolean
description:
description: |-
An optional description of this resource. Provide this property when you
create the resource.
type: string
disks:
description: |-
Array of disks associated with this instance. Persistent disks must be
created before you can assign them.
type: array
items:
$ref: AttachedDisk.yaml
displayDevice:
description: Enables display device for the instance.
$ref: DisplayDevice.yaml
eraseWindowsVssSignature:
description: |-
Specifies whether the disks restored from source snapshots or source
machine image should erase Windows specific VSS signature.
type: boolean
fingerprint:
description: |-
Specifies a fingerprint for this resource, which is essentially a hash
of the instance's contents and used for optimistic locking. The
fingerprint is initially generated by Compute Engine and changes after
every request to modify or update the instance. You must always
provide an up-to-date fingerprint hash in order to update the
instance. To see the latest fingerprint, make get() request to the
instance.
type: string
guestAccelerators:
description: |-
A list of the type and count of accelerator cards attached to the
instance.
type: array
items:
$ref: AcceleratorConfig.yaml
hostname:
description: |-
Specifies the hostname of the instance. The specified hostname
must be RFC1035 compliant. If hostname is not specified, the
default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when
using the global DNS, and
[INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal
DNS.
type: string
id:
description: |-
[Output Only] The unique identifier for the resource. This
identifier is defined by the server.
type: integer
instanceEncryptionKey:
description: |-
Encrypts or decrypts data for an instance with a customer-supplied
encryption key. If you are creating a new instance, this field
encrypts the local SSD and in-memory contents of the instance
using a key that you provide. If you are restarting an instance
protected with a customer-supplied encryption key, you must
provide the correct key in order to successfully restart the
instance. If you do not provide an encryption key when creating
the instance, then the local SSD and in-memory contents will be
encrypted using an automatically generated key and you do not need
to provide a key to start the instance later. Instance templates
do not store customer-supplied encryption keys, so you cannot use
your own keys to encrypt local SSDs and in- memory content in a
managed instance group.
$ref: CustomerEncryptionKey.yaml
kind:
description: |-
[Output Only] Type of the resource. Always compute#instance for
instances.
type: string
labelFingerprint:
description: |-
A fingerprint for this request, which is essentially a hash of the
label's contents and used for optimistic locking. The fingerprint
is initially generated by Compute Engine and changes after every
request to modify or update labels. You must always provide an up-
to-date fingerprint hash in order to update or change labels. To
see the latest fingerprint, make get() request to the instance.
type: string
labels:
description: |-
Labels to apply to this instance. These can be later modified by
the setLabels method.
$ref: LabelsValue.yaml
lastStartTimestamp:
description: |-
[Output Only] Last start timestamp in RFC3339 text format.
type: string
lastStopTimestamp:
description: |-
[Output Only] Last stop timestamp in RFC3339 text format.
type: string
lastSuspendedTimestamp:
description: |-
[Output Only] Last suspended timestamp in RFC3339 text format.
type: string
machineType:
description: |-
Full or partial URL of the machine type resource to use for this
instance, in the format: zones/zone/machineTypes/machine-type.
This is provided by the client when the instance is created. For
example, the following is a valid partial url to a predefined
machine type: zones/us- central1-f/machineTypes/n1-standard-1 To
create a custom machine type, provide a URL to a machine type in
the following format, where CPUS is 1 or an even number up to 32
(2, 4, 6, ... 24, etc), and MEMORY is the total memory for this
instance. Memory must be a multiple of 256 MB and must be supplied
in MB (e.g. 5 GB of memory is 5120 MB):
zones/zone/machineTypes/custom-CPUS-MEMORY For example:
zones/us- central1-f/machineTypes/custom-4-5120 For a full list
of restrictions, read the Specifications for custom machine types.
type: string
metadata:
description: |-
The metadata key/value pairs assigned to this instance. This
includes custom metadata and predefined keys.
$ref: Metadata.yaml
minCpuPlatform:
description: |-
"Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge".
type: string
name:
description: |-
The name of the resource, provided by the client when initially
creating the resource. The resource name must be 1-63 characters
long, and comply with RFC1035. 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.
type: string
networkInterfaces:
description: |-
An array of network configurations for this instance. These
specify how interfaces are configured to interact with other
network services, such as connecting to the internet. Multiple
interfaces are supported per instance.
type: array
items:
$ref: NetworkInterface.yaml
networkPerformanceConfig:
description: A NetworkPerformanceConfig attribute.
$ref: NetworkPerformanceConfig.yaml
params:
description: |-
Input only. [Input Only] Additional params passed with the
request, but not persisted as part of resource payload.
$ref: InstanceParams.yaml
postKeyRevocationActionType:
description: PostKeyRevocationActionType of the instance.
type: string
enum:
- NOOP
- POST_KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED
- SHUTDOWN
keyRevocationActionType:
description: KeyRevocationActionType of the instance.
type: string
enum:
- NONE
- STOP
- KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED
preservedStateSizeGb:
description: |-
Total amount of preserved state for SUSPENDED instances. Read-
only in the api.
type: integer
privateIpv6GoogleAccess:
description: |-
The private IPv6 google access type for the VM. If not
specified, use INHERIT_FROM_SUBNETWORK as default.
type: string
enum:
- ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE
- ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE
- INHERIT_FROM_SUBNETWORK
reservationAffinity:
description: |-
Specifies the reservations that this instance can consume
from.
$ref: ReservationAffinity.yaml
resourcePolicies:
description: Resource policies applied to this instance.
type: array
items:
type: string
satisfiesPzs:
description: '[Output Only] Reserved for future use.'
type: boolean
scheduling:
description: Sets the scheduling options for this instance.
$ref: Scheduling.yaml
secureLabels:
description: |-
Secure labels to apply to this instance. These can be
later modified by the update method. Maximum number of
secure labels allowed is 300.
type: array
items:
type: string
secureTags:
description: |-
Secure tags to apply to this instance. These can be
later modified by the update method. Maximum number of
secure tags allowed is 300.
type: array
items:
type: string
selfLink:
description: |-
[Output Only] Server-defined URL for this
resource.
type: string
selfLinkWithId:
description: |-
[Output Only] Server-defined URL for this resource
with the resource id.
type: string
serviceAccounts:
description: |-
A list of service accounts, with their specified
scopes, authorized for this instance. Only one
service account per VM instance is supported.
Service accounts generate access tokens that can
be accessed through the metadata server and used
to authenticate applications on the instance. See
Service Accounts for more information.
type: array
items:
$ref: ServiceAccount.yaml
shieldedInstanceConfig:
description: A ShieldedInstanceConfig attribute.
$ref: ShieldedInstanceConfig.yaml
shieldedInstanceIntegrityPolicy:
description: |-
A ShieldedInstanceIntegrityPolicy attribute.
$ref: ShieldedInstanceIntegrityPolicy.yaml
shieldedVmConfig:
description: |-
Deprecating, please use
shielded_instance_config.
$ref: ShieldedVmConfig.yaml
shieldedVmIntegrityPolicy:
description: |-
Deprecating, please use
shielded_instance_integrity_policy.
$ref: ShieldedVmIntegrityPolicy.yaml
sourceMachineImage:
description: Source machine image
type: string
sourceMachineImageEncryptionKey:
description: |-
Source GMI encryption key when creating an
instance from GMI.
$ref: CustomerEncryptionKey.yaml
startRestricted:
description: |-
[Output Only] Whether a VM has been restricted
for start because Compute Engine has detected
suspicious activity.
type: boolean
status:
description: |-
[Output Only] The status of the instance. One
of the following
type: string
enum:
- DEPROVISIONING
- PROVISIONING
- REPAIRING
- RUNNING
- STAGING
- STOPPED
- STOPPING
- SUSPENDED
- SUSPENDING
- TERMINATED
statusMessage:
description: |-
[Output Only] An optional, human-readable
explanation of the status.
type: string
tags:
description: |-
Tags to apply to this instance. Tags are used
to identify valid sources or targets for
network firewalls and are specified by the
client during instance creation. The tags can
be later modified by the setTags method. Each
tag within the list must comply with RFC1035.
Multiple tags can be specified via the
'tags.items' field.
$ref: Tags.yaml
upcomingMaintenance:
description: |-
[Output Only] Specifies upcoming maintenance
for the instance.
$ref: UpcomingMaintenance.yaml
zone:
description: |-
[Output Only] URL of the zone where the
instance resides. You must specify this field
as part of the HTTP request URL. It is not
settable as a field in the request body.
type: string

View File

@@ -0,0 +1,34 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha InstanceParams export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
resourceManagerTags:
description: |-
Resource manager tags to be bound to the instance. Tag keys and values
have the same definition as resource manager tags. Keys must be in the
format `tagKeys/{tag_key_id}`, and values are in the format
`tagValues/456`. The field is ignored (both PUT & PATCH) when empty.
$ref: ResourceManagerTagsValue.yaml

View File

@@ -0,0 +1,34 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha Int64RangeMatch export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
rangeEnd:
description: The end of the range (exclusive) in signed long integer format.
type: integer
rangeStart:
description: |-
The start of the range (inclusive) in signed long integer format.
type: integer

View File

@@ -0,0 +1,37 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha ItemsValueListEntry export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
key:
description: Key for the metadata entry. Keys must conform to the following
type: string
value:
description: |-
Value for the metadata entry. These are free-form strings, and only have
meaning as interpreted by the image running in the instance. The only
restriction placed on values is that their size must be less than or equal
to 262144 bytes (256 KiB).
type: string

View File

@@ -0,0 +1,70 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha Jwt export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
audiences:
description: |-
A JWT containing any of these audiences will be accepted. The service name
will be accepted if audiences is empty. Examples:
bookstore_android.apps.googleusercontent.com,
bookstore_web.apps.googleusercontent.com
type: array
items:
type: string
issuer:
description: |-
Identifies the issuer that issued the JWT, which is usually a URL or
an email address. Examples: https://securetoken.google.com,
1234567-compute@developer.gserviceaccount.com
type: string
jwksPublicKeys:
description: |-
The provider's public key set to validate the signature of the JWT.
type: string
jwtHeaders:
description: |-
jwt_headers and jwt_params define where to extract the JWT from an
HTTP request. If no explicit location is specified, the following
default locations are tried in order: 1. The Authorization header
using the Bearer schema. See `here `_. Example: Authorization: Bearer
. 2. `access_token` query parameter. See `this `_ Multiple JWTs can be
verified for a request. Each JWT has to be extracted from the
locations its issuer specified or from the default locations. This
field is set if JWT is sent in a request header. This field specifies
the header name. For example, if `header=x-goog-iap-jwt-assertion`,
the header format will be x-goog-iap-jwt-assertion: .
type: array
items:
$ref: JwtHeader.yaml
jwtParams:
description: |-
This field is set if JWT is sent in a query parameter. This field
specifies the query parameter name. For example, if jwt_params[0]
is jwt_token, the JWT format in the query parameter is
/path?jwt_token=.
type: array
items:
type: string

View File

@@ -0,0 +1,35 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha JwtHeader export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
name:
description: The HTTP header name.
type: string
valuePrefix:
description: |-
The value prefix. The value format is "value_prefix" For example, for
"Authorization: Bearer ", value_prefix="Bearer " with a space at the end.
type: string

View File

@@ -0,0 +1,33 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha LabelsValue export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties:
key:
description: Name of the additional property.
type: string
value:
description: A string attribute.
type: string
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string

View File

@@ -0,0 +1,49 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha Metadata export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
fingerprint:
description: |-
Specifies a fingerprint for this request, which is essentially a hash of
the metadata's contents and used for optimistic locking. The fingerprint
is initially generated by Compute Engine and changes after every request
to modify or update metadata. You must always provide an up-to-date
fingerprint hash in order to update or change metadata, otherwise the
request will fail with error 412 conditionNotMet. To see the latest
fingerprint, make a get() request to retrieve the resource.
type: string
items:
description: |-
Array of key/value pairs. The total size of all keys and values must be
less than 512 KB.
type: array
items:
$ref: ItemsValueListEntry.yaml
kind:
description: |-
[Output Only] Type of the resource. Always compute#metadata for
metadata.
type: string

View File

@@ -0,0 +1,35 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha MetadataCredentialsFromPlugin export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
name:
description: Plugin name.
type: string
structConfig:
description: |-
A text proto that conforms to a Struct type definition interpreted by the
plugin.
type: string

View File

@@ -0,0 +1,46 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha MetadataFilter export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
filterLabels:
description: |-
The list of label value pairs that must match labels in the provided
metadata based on filterMatchCriteria This list must not be empty and can
have at the most 64 entries.
type: array
items:
$ref: MetadataFilterLabelMatch.yaml
filterMatchCriteria:
description: |-
Specifies how individual filter label matches within the list of
filterLabels and contributes toward the overall metadataFilter match.
Supported values are: - MATCH_ANY: at least one of the filterLabels
must have a matching label in the provided metadata. -
type: string
enum:
- MATCH_ALL
- MATCH_ANY
- NOT_SET

View File

@@ -0,0 +1,37 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha MetadataFilterLabelMatch export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
name:
description: |-
Name of metadata label. The name can have a maximum length of 1024
characters and must be at least 1 character long.
type: string
value:
description: |-
The value of the label must match the specified value. value can have a
maximum length of 1024 characters.
type: string

View File

@@ -0,0 +1,33 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha MetadatasValue export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties:
key:
description: Name of the additional property.
type: string
value:
description: A string attribute.
type: string
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string

View File

@@ -0,0 +1,38 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha MutualTls export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
mode:
description: |-
Specifies if the server TLS is configured to be strict or permissive. This
field can be set to one of the following: STRICT: Client certificate must
be presented, connection is in TLS. PERMISSIVE: Client certificate can be
omitted, connection can be either plaintext or TLS.
type: string
enum:
- INVALID
- PERMISSIVE
- STRICT

View File

@@ -0,0 +1,161 @@
$schema: "http://json-schema.org/draft-06/schema#"
title: compute alpha NetworkInterface export schema
description: A gcloud export/import command YAML validation schema.
type: object
additionalProperties: false
properties:
COMMENT:
type: object
description: User specified info ignored by gcloud import.
additionalProperties: false
properties:
template-id:
type: string
region:
type: string
description:
type: string
date:
type: string
version:
type: string
UNKNOWN:
type: array
description: Unknown API fields that cannot be imported.
items:
type: string
accessConfigs:
description: |-
An array of configurations for this interface. Currently, only one access
config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs
specified, then this instance will have no external internet access.
type: array
items:
$ref: AccessConfig.yaml
aliasIpRanges:
description: |-
An array of alias IP ranges for this network interface. You can only
specify this field for network interfaces in VPC networks.
type: array
items:
$ref: AliasIpRange.yaml
fingerprint:
description: |-
Fingerprint hash of contents stored in this network interface.
This field will be ignored when inserting an Instance or adding a
NetworkInterface. An up-to-date fingerprint must be provided in
order to update the NetworkInterface, otherwise the request will
fail with error 412 conditionNotMet.
type: string
internalIpv6PrefixLength:
description: |-
[Output Only] The prefix length of the primary internal IPv6
range.
type: integer
ipv6AccessConfigs:
description: |-
An array of IPv6 access configurations for this interface.
Currently, only one IPv6 access config, DIRECT_IPV6, is supported.
If there is no ipv6AccessConfig specified, then this instance will
have no external IPv6 Internet access.
type: array
items:
$ref: AccessConfig.yaml
ipv6AccessType:
description: |-
[Output Only] One of EXTERNAL, INTERNAL to indicate whether
the IP can be accessed from the Internet. This field is always
inherited from its subnetwork. Valid only if stackType is
IPV4_IPV6.
type: string
enum:
- EXTERNAL
- INTERNAL
- UNSPECIFIED_IPV6_ACCESS_TYPE
ipv6Address:
description: |-
[Output Only] An IPv6 internal network address for this
network interface.
type: string
kind:
description: |-
[Output Only] Type of the resource. Always
compute#networkInterface for network interfaces.
type: string
name:
description: |-
[Output Only] The name of the network interface, which is
generated by the server. For network devices, these are eth0,
eth1, etc.
type: string
network:
description: |-
URL of the network resource for this instance. When creating
an instance, if neither the network nor the subnetwork is
specified, the default network global/networks/default is
used; if the network is not specified but the subnetwork is
specified, the network is inferred. If you specify this
property, you can specify the network as a full or partial
URL. For example, the following are all valid URLs: -
https:// www.googleapis.com/compute/v1/projects/project/global
/networks/network - projects/project/global/networks/network
- global/networks/default
type: string
networkIP:
description: |-
An IPv4 internal IP address to assign to the instance for this
network interface. If not specified by the user, an unused
internal IP is assigned by the system.
type: string
nicType:
description: |-
The type of vNIC to be used on this interface. This may be
gVNIC or VirtioNet.
type: string
enum:
- GVNIC
- UNSPECIFIED_NIC_TYPE
- VIRTIO_NET
queueCount:
description: |-
The networking queue count that's specified by users for the
network interface. Both Rx and Tx queues will be set to this
number. It'll be empty if not specified by the users.
type: integer
stackType:
description: |-
The stack type for this network interface to identify whether
the IPv6 feature is enabled or not. If not specified,
IPV4_ONLY will be used. This field can be both set at
instance creation and update network interface operations.
type: string
enum:
- IPV4_IPV6
- IPV4_ONLY
- IPV6_ONLY
- UNSPECIFIED_STACK_TYPE
subinterfaces:
description: |-
SubInterfaces help enable L2 communication for the instance
over subnetworks that support L2. Every network interface will
get a default untagged (vlan not specified) subinterface.
Users can specify additional tagged subinterfaces which are
sub-fields to the Network Interface.
type: array
items:
$ref: NetworkInterfaceSubInterface.yaml
subnetwork:
description: |-
The URL of the Subnetwork resource for this instance. If
the network resource is in legacy mode, do not specify
this field. If the network is in auto subnet mode,
specifying the subnetwork is optional. If the network is
in custom subnet mode, specifying the subnetwork is
required. If you specify this field, you can specify the
subnetwork as a full or partial URL. For example, the
following are all valid URLs: - https://www.googleapis.c
om/compute/v1/projects/project/regions/region/su
bnetworks/subnetwork -
regions/region/subnetworks/subnetwork
type: string

Some files were not shown because too many files have changed in this diff Show More