chiu
/
google-api-ruby-client
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
google-api-ruby-client/generated/google/apis/compute_v1/classes.rb

33718 lines
1.4 MiB
Raw Blame History

# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'date'
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module ComputeV1
# A specification of the type and number of accelerator cards attached to the
# instance.
class AcceleratorConfig
include Google::Apis::Core::Hashable
# The number of the guest accelerator cards exposed to this instance.
# Corresponds to the JSON property `acceleratorCount`
# @return [Fixnum]
attr_accessor :accelerator_count
# 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.
# Corresponds to the JSON property `acceleratorType`
# @return [String]
attr_accessor :accelerator_type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@accelerator_count = args[:accelerator_count] if args.key?(:accelerator_count)
@accelerator_type = args[:accelerator_type] if args.key?(:accelerator_type)
end
end
# Represents an Accelerator Type resource.
# Google Cloud Platform provides graphics processing units (accelerators) that
# you can add to VM instances to improve or accelerate performance when working
# with intensive workloads. For more information, read GPUs on Compute Engine. (=
# = resource_for `$api_version`.acceleratorTypes ==)
class AcceleratorType
include Google::Apis::Core::Hashable
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# Deprecation status for a public resource.
# Corresponds to the JSON property `deprecated`
# @return [Google::Apis::ComputeV1::DeprecationStatus]
attr_accessor :deprecated
# [Output Only] An optional textual description of the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] The type of the resource. Always compute#acceleratorType for
# accelerator types.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] Maximum number of accelerator cards allowed per instance.
# Corresponds to the JSON property `maximumCardsPerInstance`
# @return [Fixnum]
attr_accessor :maximum_cards_per_instance
# [Output Only] Name of the resource.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# [Output Only] Server-defined, fully qualified URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] The name of the zone where the accelerator type resides, such as
# us-central1-a. You must specify this field as part of the HTTP request URL. It
# is not settable as a field in the request body.
# Corresponds to the JSON property `zone`
# @return [String]
attr_accessor :zone
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@deprecated = args[:deprecated] if args.key?(:deprecated)
@description = args[:description] if args.key?(:description)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@maximum_cards_per_instance = args[:maximum_cards_per_instance] if args.key?(:maximum_cards_per_instance)
@name = args[:name] if args.key?(:name)
@self_link = args[:self_link] if args.key?(:self_link)
@zone = args[:zone] if args.key?(:zone)
end
end
#
class AcceleratorTypeAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of AcceleratorTypesScopedList resources.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::AcceleratorTypesScopedList>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#acceleratorTypeAggregatedList
# for aggregated lists of accelerator types.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::AcceleratorTypeAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::AcceleratorTypeAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Contains a list of accelerator types.
class AcceleratorTypeList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of AcceleratorType resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::AcceleratorType>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#acceleratorTypeList for lists
# of accelerator types.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::AcceleratorTypeList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::AcceleratorTypeList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class AcceleratorTypesScopedList
include Google::Apis::Core::Hashable
# [Output Only] A list of accelerator types contained in this scope.
# Corresponds to the JSON property `acceleratorTypes`
# @return [Array<Google::Apis::ComputeV1::AcceleratorType>]
attr_accessor :accelerator_types
# [Output Only] An informational warning that appears when the accelerator types
# list is empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::AcceleratorTypesScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@accelerator_types = args[:accelerator_types] if args.key?(:accelerator_types)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] An informational warning that appears when the accelerator types
# list is empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::AcceleratorTypesScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# An access configuration attached to an instance's network interface. Only one
# access config per instance is supported.
class AccessConfig
include Google::Apis::Core::Hashable
# [Output Only] Type of the resource. Always compute#accessConfig for access
# configs.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# 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.
# Corresponds to the JSON property `natIP`
# @return [String]
attr_accessor :nat_ip
# 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.
# Corresponds to the JSON property `networkTier`
# @return [String]
attr_accessor :network_tier
# The DNS domain name for the public PTR record. You can set this field only if
# the `setPublicPtr` field is enabled.
# Corresponds to the JSON property `publicPtrDomainName`
# @return [String]
attr_accessor :public_ptr_domain_name
# Specifies whether a public DNS 'PTR' record should be created to map the
# external IP address of the instance to a DNS domain name.
# Corresponds to the JSON property `setPublicPtr`
# @return [Boolean]
attr_accessor :set_public_ptr
alias_method :set_public_ptr?, :set_public_ptr
# The type of configuration. The default and only option is ONE_TO_ONE_NAT.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@nat_ip = args[:nat_ip] if args.key?(:nat_ip)
@network_tier = args[:network_tier] if args.key?(:network_tier)
@public_ptr_domain_name = args[:public_ptr_domain_name] if args.key?(:public_ptr_domain_name)
@set_public_ptr = args[:set_public_ptr] if args.key?(:set_public_ptr)
@type = args[:type] if args.key?(:type)
end
end
# Use global external addresses for GFE-based external HTTP(S) load balancers in
# Premium Tier.
# Use global internal addresses for reserved peering network range.
# Use regional external addresses for the following resources:
# - External IP addresses for VM instances - Regional external forwarding rules -
# Cloud NAT external IP addresses - GFE based LBs in Standard Tier - Network
# LBs in Premium or Standard Tier - Cloud VPN gateways (both Classic and HA)
# Use regional internal IP addresses for subnet IP ranges (primary and secondary)
# . This includes:
# - Internal IP addresses for VM instances - Alias IP ranges of VM instances (/
# 32 only) - Regional internal forwarding rules - Internal TCP/UDP load balancer
# addresses - Internal HTTP(S) load balancer addresses - Cloud DNS inbound
# forwarding IP addresses
# For more information, read reserved IP address.
# (== resource_for `$api_version`.addresses ==) (== resource_for `$api_version`.
# globalAddresses ==)
class Address
include Google::Apis::Core::Hashable
# The static IP address represented by this resource.
# Corresponds to the JSON property `address`
# @return [String]
attr_accessor :address
# The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified,
# defaults to EXTERNAL.
# Corresponds to the JSON property `addressType`
# @return [String]
attr_accessor :address_type
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this field when you create
# the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# The IP version that will be used by this address. Valid options are IPV4 or
# IPV6. This can only be specified for a global address.
# Corresponds to the JSON property `ipVersion`
# @return [String]
attr_accessor :ip_version
# [Output Only] Type of the resource. Always compute#address for addresses.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# 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])?`. The first character must be a lowercase letter, and all
# following characters (except for the last character) must be a dash, lowercase
# letter, or digit. The last character must be a lowercase letter or digit.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The URL of the network in which to reserve the address. This field can only be
# used with INTERNAL type with the VPC_PEERING purpose.
# Corresponds to the JSON property `network`
# @return [String]
attr_accessor :network
# This signifies the networking tier used for configuring this address and can
# only take the following values: PREMIUM or STANDARD. Global forwarding rules
# can only be Premium Tier. Regional forwarding rules can be either Premium or
# Standard Tier. Standard Tier addresses applied to regional forwarding rules
# can be used with any external load balancer. Regional forwarding rules in
# Premium Tier can only be used with a network load balancer.
# If this field is not specified, it is assumed to be PREMIUM.
# Corresponds to the JSON property `networkTier`
# @return [String]
attr_accessor :network_tier
# The prefix length if the resource reprensents an IP range.
# Corresponds to the JSON property `prefixLength`
# @return [Fixnum]
attr_accessor :prefix_length
# The purpose of this resource, which can be one of the following values:
# - `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges,
# internal load balancers, and similar resources.
# - `DNS_RESOLVER` for a DNS resolver address in a subnetwork
# - `VPC_PEERING` for addresses that are reserved for VPC peer networks.
# - `NAT_AUTO` for addresses that are external IP addresses automatically
# reserved for Cloud NAT.
# Corresponds to the JSON property `purpose`
# @return [String]
attr_accessor :purpose
# [Output Only] The URL of the region where the regional address resides. This
# field is not applicable to global addresses. You must specify this field as
# part of the HTTP request URL.
# Corresponds to the JSON property `region`
# @return [String]
attr_accessor :region
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] The status of the address, which can be one of RESERVING,
# RESERVED, or IN_USE. An address that is RESERVING is currently in the process
# of being reserved. A RESERVED address is currently reserved and available to
# use. An IN_USE address is currently being used by another resource and is not
# available.
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
# The URL of the subnetwork in which to reserve the address. If an IP address is
# specified, it must be within the subnetwork's IP range. This field can only be
# used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.
# Corresponds to the JSON property `subnetwork`
# @return [String]
attr_accessor :subnetwork
# [Output Only] The URLs of the resources that are using this address.
# Corresponds to the JSON property `users`
# @return [Array<String>]
attr_accessor :users
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@address = args[:address] if args.key?(:address)
@address_type = args[:address_type] if args.key?(:address_type)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@id = args[:id] if args.key?(:id)
@ip_version = args[:ip_version] if args.key?(:ip_version)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@network = args[:network] if args.key?(:network)
@network_tier = args[:network_tier] if args.key?(:network_tier)
@prefix_length = args[:prefix_length] if args.key?(:prefix_length)
@purpose = args[:purpose] if args.key?(:purpose)
@region = args[:region] if args.key?(:region)
@self_link = args[:self_link] if args.key?(:self_link)
@status = args[:status] if args.key?(:status)
@subnetwork = args[:subnetwork] if args.key?(:subnetwork)
@users = args[:users] if args.key?(:users)
end
end
#
class AddressAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of AddressesScopedList resources.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::AddressesScopedList>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#addressAggregatedList for
# aggregated lists of addresses.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::AddressAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::AddressAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Contains a list of addresses.
class AddressList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of Address resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::Address>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#addressList for lists of
# addresses.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::AddressList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::AddressList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class AddressesScopedList
include Google::Apis::Core::Hashable
# [Output Only] A list of addresses contained in this scope.
# Corresponds to the JSON property `addresses`
# @return [Array<Google::Apis::ComputeV1::Address>]
attr_accessor :addresses
# [Output Only] Informational warning which replaces the list of addresses when
# the list is empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::AddressesScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@addresses = args[:addresses] if args.key?(:addresses)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning which replaces the list of addresses when
# the list is empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::AddressesScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# An alias IP range attached to an instance's network interface.
class AliasIpRange
include Google::Apis::Core::Hashable
# 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).
# Corresponds to the JSON property `ipCidrRange`
# @return [String]
attr_accessor :ip_cidr_range
# 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.
# Corresponds to the JSON property `subnetworkRangeName`
# @return [String]
attr_accessor :subnetwork_range_name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@ip_cidr_range = args[:ip_cidr_range] if args.key?(:ip_cidr_range)
@subnetwork_range_name = args[:subnetwork_range_name] if args.key?(:subnetwork_range_name)
end
end
#
class AllocationSpecificSkuAllocationAllocatedInstancePropertiesReservedDisk
include Google::Apis::Core::Hashable
# Specifies the size of the disk in base-2 GB.
# Corresponds to the JSON property `diskSizeGb`
# @return [Fixnum]
attr_accessor :disk_size_gb
# Specifies the disk interface to use for attaching this disk, which is either
# SCSI or NVME. The default is SCSI. For performance characteristics of SCSI
# over NVMe, see Local SSD performance.
# Corresponds to the JSON property `interface`
# @return [String]
attr_accessor :interface
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb)
@interface = args[:interface] if args.key?(:interface)
end
end
# Properties of the SKU instances being reserved. Next ID: 9
class AllocationSpecificSkuAllocationReservedInstanceProperties
include Google::Apis::Core::Hashable
# Specifies accelerator type and count.
# Corresponds to the JSON property `guestAccelerators`
# @return [Array<Google::Apis::ComputeV1::AcceleratorConfig>]
attr_accessor :guest_accelerators
# Specifies amount of local ssd to reserve with each instance. The type of disk
# is local-ssd.
# Corresponds to the JSON property `localSsds`
# @return [Array<Google::Apis::ComputeV1::AllocationSpecificSkuAllocationAllocatedInstancePropertiesReservedDisk>]
attr_accessor :local_ssds
# Specifies type of machine (name only) which has fixed number of vCPUs and
# fixed amount of memory. This also includes specifying custom machine type
# following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.
# Corresponds to the JSON property `machineType`
# @return [String]
attr_accessor :machine_type
# Specifies whether this VM may be a stable fleet VM. Setting this to "Periodic"
# designates this VM as a Stable Fleet VM.
# See go/stable-fleet-ug for more details.
# Corresponds to the JSON property `maintenanceInterval`
# @return [String]
attr_accessor :maintenance_interval
# Minimum cpu platform the reservation.
# Corresponds to the JSON property `minCpuPlatform`
# @return [String]
attr_accessor :min_cpu_platform
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@guest_accelerators = args[:guest_accelerators] if args.key?(:guest_accelerators)
@local_ssds = args[:local_ssds] if args.key?(:local_ssds)
@machine_type = args[:machine_type] if args.key?(:machine_type)
@maintenance_interval = args[:maintenance_interval] if args.key?(:maintenance_interval)
@min_cpu_platform = args[:min_cpu_platform] if args.key?(:min_cpu_platform)
end
end
# This reservation type allows to pre allocate specific instance configuration.
class AllocationSpecificSkuReservation
include Google::Apis::Core::Hashable
# Specifies the number of resources that are allocated.
# Corresponds to the JSON property `count`
# @return [Fixnum]
attr_accessor :count
# [Output Only] Indicates how many instances are in use.
# Corresponds to the JSON property `inUseCount`
# @return [Fixnum]
attr_accessor :in_use_count
# Properties of the SKU instances being reserved. Next ID: 9
# Corresponds to the JSON property `instanceProperties`
# @return [Google::Apis::ComputeV1::AllocationSpecificSkuAllocationReservedInstanceProperties]
attr_accessor :instance_properties
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@count = args[:count] if args.key?(:count)
@in_use_count = args[:in_use_count] if args.key?(:in_use_count)
@instance_properties = args[:instance_properties] if args.key?(:instance_properties)
end
end
# An instance-attached disk resource.
class AttachedDisk
include Google::Apis::Core::Hashable
# Specifies whether the disk will be auto-deleted when the instance is deleted (
# but not when the disk is detached from the instance).
# Corresponds to the JSON property `autoDelete`
# @return [Boolean]
attr_accessor :auto_delete
alias_method :auto_delete?, :auto_delete
# Indicates that this is a boot disk. The virtual machine will use the first
# partition of the disk for its root filesystem.
# Corresponds to the JSON property `boot`
# @return [Boolean]
attr_accessor :boot
alias_method :boot?, :boot
# 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.
# Corresponds to the JSON property `deviceName`
# @return [String]
attr_accessor :device_name
# Represents a customer-supplied encryption key
# Corresponds to the JSON property `diskEncryptionKey`
# @return [Google::Apis::ComputeV1::CustomerEncryptionKey]
attr_accessor :disk_encryption_key
# The size of the disk in GB.
# Corresponds to the JSON property `diskSizeGb`
# @return [Fixnum]
attr_accessor :disk_size_gb
# 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.
# Corresponds to the JSON property `guestOsFeatures`
# @return [Array<Google::Apis::ComputeV1::GuestOsFeature>]
attr_accessor :guest_os_features
# [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.
# Corresponds to the JSON property `index`
# @return [Fixnum]
attr_accessor :index
# [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.
# Corresponds to the JSON property `initializeParams`
# @return [Google::Apis::ComputeV1::AttachedDiskInitializeParams]
attr_accessor :initialize_params
# 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.
# Corresponds to the JSON property `interface`
# @return [String]
attr_accessor :interface
# [Output Only] Type of the resource. Always compute#attachedDisk for attached
# disks.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] Any valid publicly visible licenses.
# Corresponds to the JSON property `licenses`
# @return [Array<String>]
attr_accessor :licenses
# 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.
# Corresponds to the JSON property `mode`
# @return [String]
attr_accessor :mode
# Initial State for shielded instance, these are public keys which are safe to
# store in public
# Corresponds to the JSON property `shieldedInstanceInitialState`
# @return [Google::Apis::ComputeV1::InitialStateConfig]
attr_accessor :shielded_instance_initial_state
# 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.
# Corresponds to the JSON property `source`
# @return [String]
attr_accessor :source
# Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified,
# the default is PERSISTENT.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@auto_delete = args[:auto_delete] if args.key?(:auto_delete)
@boot = args[:boot] if args.key?(:boot)
@device_name = args[:device_name] if args.key?(:device_name)
@disk_encryption_key = args[:disk_encryption_key] if args.key?(:disk_encryption_key)
@disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb)
@guest_os_features = args[:guest_os_features] if args.key?(:guest_os_features)
@index = args[:index] if args.key?(:index)
@initialize_params = args[:initialize_params] if args.key?(:initialize_params)
@interface = args[:interface] if args.key?(:interface)
@kind = args[:kind] if args.key?(:kind)
@licenses = args[:licenses] if args.key?(:licenses)
@mode = args[:mode] if args.key?(:mode)
@shielded_instance_initial_state = args[:shielded_instance_initial_state] if args.key?(:shielded_instance_initial_state)
@source = args[:source] if args.key?(:source)
@type = args[:type] if args.key?(:type)
end
end
# [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.
class AttachedDiskInitializeParams
include Google::Apis::Core::Hashable
# An optional description. Provide this property when creating the disk.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :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.
# Corresponds to the JSON property `diskName`
# @return [String]
attr_accessor :disk_name
# 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.
# Corresponds to the JSON property `diskSizeGb`
# @return [Fixnum]
attr_accessor :disk_size_gb
# Specifies the disk type to use to create the instance. If not specified, the
# default is pd-standard, specified using the full URL. For example:
# https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-
# standard
# Other values include pd-ssd and local-ssd. If you define this field, you can
# provide either the full or partial URL. For example, the following are valid
# values:
# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/
# diskType
# - projects/project/zones/zone/diskTypes/diskType
# - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the
# name of the disk type, not URL.
# Corresponds to the JSON property `diskType`
# @return [String]
attr_accessor :disk_type
# Labels to apply to this disk. These can be later modified by the disks.
# setLabels method. This field is only applicable for persistent disks.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
# Specifies which action to take on instance update with this disk. Default is
# to use the existing disk.
# Corresponds to the JSON property `onUpdateAction`
# @return [String]
attr_accessor :on_update_action
# 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.
# Corresponds to the JSON property `resourcePolicies`
# @return [Array<String>]
attr_accessor :resource_policies
# 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 format:
# global/images/my-custom-image
# You can also specify a custom image by its image family, which returns the
# latest version of the image in that family. Replace the image name with family/
# family-name:
# global/images/family/my-image-family
# If the source image is deleted later, this field will not be set.
# Corresponds to the JSON property `sourceImage`
# @return [String]
attr_accessor :source_image
# Represents a customer-supplied encryption key
# Corresponds to the JSON property `sourceImageEncryptionKey`
# @return [Google::Apis::ComputeV1::CustomerEncryptionKey]
attr_accessor :source_image_encryption_key
# 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.
# Corresponds to the JSON property `sourceSnapshot`
# @return [String]
attr_accessor :source_snapshot
# Represents a customer-supplied encryption key
# Corresponds to the JSON property `sourceSnapshotEncryptionKey`
# @return [Google::Apis::ComputeV1::CustomerEncryptionKey]
attr_accessor :source_snapshot_encryption_key
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@description = args[:description] if args.key?(:description)
@disk_name = args[:disk_name] if args.key?(:disk_name)
@disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb)
@disk_type = args[:disk_type] if args.key?(:disk_type)
@labels = args[:labels] if args.key?(:labels)
@on_update_action = args[:on_update_action] if args.key?(:on_update_action)
@resource_policies = args[:resource_policies] if args.key?(:resource_policies)
@source_image = args[:source_image] if args.key?(:source_image)
@source_image_encryption_key = args[:source_image_encryption_key] if args.key?(:source_image_encryption_key)
@source_snapshot = args[:source_snapshot] if args.key?(:source_snapshot)
@source_snapshot_encryption_key = args[:source_snapshot_encryption_key] if args.key?(:source_snapshot_encryption_key)
end
end
# Specifies the audit configuration for a service. The configuration determines
# which permission types are logged, and what identities, if any, are exempted
# from logging. An AuditConfig must have one or more AuditLogConfigs.
# If there are AuditConfigs for both `allServices` and a specific service, the
# union of the two AuditConfigs is used for that service: the log_types
# specified in each AuditConfig are enabled, and the exempted_members in each
# AuditLogConfig are exempted.
# Example Policy with multiple AuditConfigs:
# ` "audit_configs": [ ` "service": "allServices", "audit_log_configs": [ ` "
# log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] `, ` "
# log_type": "DATA_WRITE" `, ` "log_type": "ADMIN_READ" ` ] `, ` "service": "
# sampleservice.googleapis.com", "audit_log_configs": [ ` "log_type": "DATA_READ"
# `, ` "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com"
# ] ` ] ` ] `
# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
# logging. It also exempts jose@example.com from DATA_READ logging, and aliya@
# example.com from DATA_WRITE logging.
class AuditConfig
include Google::Apis::Core::Hashable
# The configuration for logging of each type of permission.
# Corresponds to the JSON property `auditLogConfigs`
# @return [Array<Google::Apis::ComputeV1::AuditLogConfig>]
attr_accessor :audit_log_configs
#
# Corresponds to the JSON property `exemptedMembers`
# @return [Array<String>]
attr_accessor :exempted_members
# Specifies a service that will be enabled for audit logging. For example, `
# storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special
# value that covers all services.
# Corresponds to the JSON property `service`
# @return [String]
attr_accessor :service
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@audit_log_configs = args[:audit_log_configs] if args.key?(:audit_log_configs)
@exempted_members = args[:exempted_members] if args.key?(:exempted_members)
@service = args[:service] if args.key?(:service)
end
end
# Provides the configuration for logging a type of permissions. Example:
# ` "audit_log_configs": [ ` "log_type": "DATA_READ", "exempted_members": [ "
# user:jose@example.com" ] `, ` "log_type": "DATA_WRITE" ` ] `
# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@
# example.com from DATA_READ logging.
class AuditLogConfig
include Google::Apis::Core::Hashable
# Specifies the identities that do not cause logging for this type of permission.
# Follows the same format of [Binding.members][].
# Corresponds to the JSON property `exemptedMembers`
# @return [Array<String>]
attr_accessor :exempted_members
#
# Corresponds to the JSON property `ignoreChildExemptions`
# @return [Boolean]
attr_accessor :ignore_child_exemptions
alias_method :ignore_child_exemptions?, :ignore_child_exemptions
# The log type that this config enables.
# Corresponds to the JSON property `logType`
# @return [String]
attr_accessor :log_type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@exempted_members = args[:exempted_members] if args.key?(:exempted_members)
@ignore_child_exemptions = args[:ignore_child_exemptions] if args.key?(:ignore_child_exemptions)
@log_type = args[:log_type] if args.key?(:log_type)
end
end
# Authorization-related information used by Cloud Audit Logging.
class AuthorizationLoggingOptions
include Google::Apis::Core::Hashable
# The type of the permission that was checked.
# Corresponds to the JSON property `permissionType`
# @return [String]
attr_accessor :permission_type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@permission_type = args[:permission_type] if args.key?(:permission_type)
end
end
# Represents an Autoscaler resource.
# Google Compute Engine has two Autoscaler resources:
# * [Global](/compute/docs/reference/rest/`$api_version`/autoscalers) * [
# Regional](/compute/docs/reference/rest/`$api_version`/regionAutoscalers)
# Use autoscalers to automatically add or delete instances from a managed
# instance group according to your defined autoscaling policy. For more
# information, read Autoscaling Groups of Instances.
# For zonal managed instance groups resource, use the autoscaler resource.
# For regional managed instance groups, use the regionAutoscalers resource. (==
# resource_for `$api_version`.autoscalers ==) (== resource_for `$api_version`.
# regionAutoscalers ==)
class Autoscaler
include Google::Apis::Core::Hashable
# Cloud Autoscaler policy.
# Corresponds to the JSON property `autoscalingPolicy`
# @return [Google::Apis::ComputeV1::AutoscalingPolicy]
attr_accessor :autoscaling_policy
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] Type of the resource. Always compute#autoscaler for autoscalers.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# [Output Only] Target recommended MIG size (number of instances) computed by
# autoscaler. Autoscaler calculates recommended MIG size even when autoscaling
# policy mode is different from ON. This field is empty when autoscaler is not
# connected to the existing managed instance group or autoscaler did not
# generate its prediction.
# Corresponds to the JSON property `recommendedSize`
# @return [Fixnum]
attr_accessor :recommended_size
# [Output Only] URL of the region where the instance group resides (for
# autoscalers living in regional scope).
# Corresponds to the JSON property `region`
# @return [String]
attr_accessor :region
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] The status of the autoscaler configuration. Current set of
# possible values:
# - PENDING: Autoscaler backend hasn't read new/updated configuration.
# - DELETING: Configuration is being deleted.
# - ACTIVE: Configuration is acknowledged to be effective. Some warnings might
# be present in the statusDetails field.
# - ERROR: Configuration has errors. Actionable for users. Details are present
# in the statusDetails field. New values might be added in the future.
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
# [Output Only] Human-readable details about the current state of the autoscaler.
# Read the documentation for Commonly returned status messages for examples of
# status messages you might encounter.
# Corresponds to the JSON property `statusDetails`
# @return [Array<Google::Apis::ComputeV1::AutoscalerStatusDetails>]
attr_accessor :status_details
# URL of the managed instance group that this autoscaler will scale.
# Corresponds to the JSON property `target`
# @return [String]
attr_accessor :target
# [Output Only] URL of the zone where the instance group resides (for
# autoscalers living in zonal scope).
# Corresponds to the JSON property `zone`
# @return [String]
attr_accessor :zone
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@autoscaling_policy = args[:autoscaling_policy] if args.key?(:autoscaling_policy)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@recommended_size = args[:recommended_size] if args.key?(:recommended_size)
@region = args[:region] if args.key?(:region)
@self_link = args[:self_link] if args.key?(:self_link)
@status = args[:status] if args.key?(:status)
@status_details = args[:status_details] if args.key?(:status_details)
@target = args[:target] if args.key?(:target)
@zone = args[:zone] if args.key?(:zone)
end
end
#
class AutoscalerAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of AutoscalersScopedList resources.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::AutoscalersScopedList>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#autoscalerAggregatedList for
# aggregated lists of autoscalers.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::AutoscalerAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::AutoscalerAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Contains a list of Autoscaler resources.
class AutoscalerList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of Autoscaler resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::Autoscaler>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#autoscalerList for lists of
# autoscalers.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::AutoscalerList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::AutoscalerList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class AutoscalerStatusDetails
include Google::Apis::Core::Hashable
# The status message.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
# The type of error, warning, or notice returned. Current set of possible values:
#
# - ALL_INSTANCES_UNHEALTHY (WARNING): All instances in the instance group are
# unhealthy (not in RUNNING state).
# - BACKEND_SERVICE_DOES_NOT_EXIST (ERROR): There is no backend service attached
# to the instance group.
# - CAPPED_AT_MAX_NUM_REPLICAS (WARNING): Autoscaler recommends a size greater
# than maxNumReplicas.
# - CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE (WARNING): The custom metric samples
# are not exported often enough to be a credible base for autoscaling.
# - CUSTOM_METRIC_INVALID (ERROR): The custom metric that was specified does not
# exist or does not have the necessary labels.
# - MIN_EQUALS_MAX (WARNING): The minNumReplicas is equal to maxNumReplicas.
# This means the autoscaler cannot add or remove instances from the instance
# group.
# - MISSING_CUSTOM_METRIC_DATA_POINTS (WARNING): The autoscaler did not receive
# any data from the custom metric configured for autoscaling.
# - MISSING_LOAD_BALANCING_DATA_POINTS (WARNING): The autoscaler is configured
# to scale based on a load balancing signal but the instance group has not
# received any requests from the load balancer.
# - MODE_OFF (WARNING): Autoscaling is turned off. The number of instances in
# the group won't change automatically. The autoscaling configuration is
# preserved.
# - MODE_ONLY_UP (WARNING): Autoscaling is in the "Autoscale only up" mode. The
# autoscaler can add instances but not remove any.
# - MORE_THAN_ONE_BACKEND_SERVICE (ERROR): The instance group cannot be
# autoscaled because it has more than one backend service attached to it.
# - NOT_ENOUGH_QUOTA_AVAILABLE (ERROR): There is insufficient quota for the
# necessary resources, such as CPU or number of instances.
# - REGION_RESOURCE_STOCKOUT (ERROR): Shown only for regional autoscalers: there
# is a resource stockout in the chosen region.
# - SCALING_TARGET_DOES_NOT_EXIST (ERROR): The target to be scaled does not
# exist.
# - UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION (ERROR): Autoscaling does
# not work with an HTTP/S load balancer that has been configured for maxRate.
# - ZONE_RESOURCE_STOCKOUT (ERROR): For zonal autoscalers: there is a resource
# stockout in the chosen zone. For regional autoscalers: in at least one of the
# zones you're using there is a resource stockout. New values might be added in
# the future. Some of the values might not be available in all API versions.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@message = args[:message] if args.key?(:message)
@type = args[:type] if args.key?(:type)
end
end
#
class AutoscalersScopedList
include Google::Apis::Core::Hashable
# [Output Only] A list of autoscalers contained in this scope.
# Corresponds to the JSON property `autoscalers`
# @return [Array<Google::Apis::ComputeV1::Autoscaler>]
attr_accessor :autoscalers
# [Output Only] Informational warning which replaces the list of autoscalers
# when the list is empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::AutoscalersScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@autoscalers = args[:autoscalers] if args.key?(:autoscalers)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning which replaces the list of autoscalers
# when the list is empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::AutoscalersScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Cloud Autoscaler policy.
class AutoscalingPolicy
include Google::Apis::Core::Hashable
# The number of seconds that the autoscaler should wait before it starts
# collecting information from a new instance. This prevents the autoscaler from
# collecting information when the instance is initializing, during which the
# collected usage would not be reliable. The default time autoscaler waits is 60
# seconds.
# Virtual machine initialization times might vary because of numerous factors.
# We recommend that you test how long an instance may take to initialize. To do
# this, create an instance and time the startup process.
# Corresponds to the JSON property `coolDownPeriodSec`
# @return [Fixnum]
attr_accessor :cool_down_period_sec
# CPU utilization policy.
# Corresponds to the JSON property `cpuUtilization`
# @return [Google::Apis::ComputeV1::AutoscalingPolicyCpuUtilization]
attr_accessor :cpu_utilization
# Configuration parameters of autoscaling based on a custom metric.
# Corresponds to the JSON property `customMetricUtilizations`
# @return [Array<Google::Apis::ComputeV1::AutoscalingPolicyCustomMetricUtilization>]
attr_accessor :custom_metric_utilizations
# Configuration parameters of autoscaling based on load balancing.
# Corresponds to the JSON property `loadBalancingUtilization`
# @return [Google::Apis::ComputeV1::AutoscalingPolicyLoadBalancingUtilization]
attr_accessor :load_balancing_utilization
# The maximum number of instances that the autoscaler can scale up to. This is
# required when creating or updating an autoscaler. The maximum number of
# replicas should not be lower than minimal number of replicas.
# Corresponds to the JSON property `maxNumReplicas`
# @return [Fixnum]
attr_accessor :max_num_replicas
# The minimum number of replicas that the autoscaler can scale down to. This
# cannot be less than 0. If not provided, autoscaler will choose a default value
# depending on maximum number of instances allowed.
# Corresponds to the JSON property `minNumReplicas`
# @return [Fixnum]
attr_accessor :min_num_replicas
# Defines operating mode for this policy.
# Corresponds to the JSON property `mode`
# @return [String]
attr_accessor :mode
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@cool_down_period_sec = args[:cool_down_period_sec] if args.key?(:cool_down_period_sec)
@cpu_utilization = args[:cpu_utilization] if args.key?(:cpu_utilization)
@custom_metric_utilizations = args[:custom_metric_utilizations] if args.key?(:custom_metric_utilizations)
@load_balancing_utilization = args[:load_balancing_utilization] if args.key?(:load_balancing_utilization)
@max_num_replicas = args[:max_num_replicas] if args.key?(:max_num_replicas)
@min_num_replicas = args[:min_num_replicas] if args.key?(:min_num_replicas)
@mode = args[:mode] if args.key?(:mode)
end
end
# CPU utilization policy.
class AutoscalingPolicyCpuUtilization
include Google::Apis::Core::Hashable
# The target CPU utilization that the autoscaler should maintain. Must be a
# float value in the range (0, 1]. If not specified, the default is 0.6.
# If the CPU level is below the target utilization, the autoscaler scales down
# the number of instances until it reaches the minimum number of instances you
# specified or until the average CPU of your instances reaches the target
# utilization.
# If the average CPU is above the target utilization, the autoscaler scales up
# until it reaches the maximum number of instances you specified or until the
# average utilization reaches the target utilization.
# Corresponds to the JSON property `utilizationTarget`
# @return [Float]
attr_accessor :utilization_target
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@utilization_target = args[:utilization_target] if args.key?(:utilization_target)
end
end
# Custom utilization metric policy.
class AutoscalingPolicyCustomMetricUtilization
include Google::Apis::Core::Hashable
# The identifier (type) of the Stackdriver Monitoring metric. The metric cannot
# have negative values.
# The metric must have a value type of INT64 or DOUBLE.
# Corresponds to the JSON property `metric`
# @return [String]
attr_accessor :metric
# The target value of the metric that autoscaler should maintain. This must be a
# positive value. A utilization metric scales number of virtual machines
# handling requests to increase or decrease proportionally to the metric.
# For example, a good metric to use as a utilization_target is compute.
# googleapis.com/instance/network/received_bytes_count. The autoscaler will work
# to keep this value constant for each of the instances.
# Corresponds to the JSON property `utilizationTarget`
# @return [Float]
attr_accessor :utilization_target
# Defines how target utilization value is expressed for a Stackdriver Monitoring
# metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE.
# Corresponds to the JSON property `utilizationTargetType`
# @return [String]
attr_accessor :utilization_target_type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@metric = args[:metric] if args.key?(:metric)
@utilization_target = args[:utilization_target] if args.key?(:utilization_target)
@utilization_target_type = args[:utilization_target_type] if args.key?(:utilization_target_type)
end
end
# Configuration parameters of autoscaling based on load balancing.
class AutoscalingPolicyLoadBalancingUtilization
include Google::Apis::Core::Hashable
# Fraction of backend capacity utilization (set in HTTP(S) load balancing
# configuration) that autoscaler should maintain. Must be a positive float value.
# If not defined, the default is 0.8.
# Corresponds to the JSON property `utilizationTarget`
# @return [Float]
attr_accessor :utilization_target
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@utilization_target = args[:utilization_target] if args.key?(:utilization_target)
end
end
# Message containing information of one individual backend.
class Backend
include Google::Apis::Core::Hashable
# Specifies the balancing mode for the backend.
# When choosing a balancing mode, you need to consider the loadBalancingScheme,
# and protocol for the backend service, as well as the type of backend (instance
# group or NEG).
#
# - If the load balancing mode is CONNECTION, then the load is spread based on
# how many concurrent connections the backend can handle.
# You can use the CONNECTION balancing mode if the protocol for the backend
# service is SSL, TCP, or UDP.
# If the loadBalancingScheme for the backend service is EXTERNAL (SSL Proxy and
# TCP Proxy load balancers), you must also specify exactly one of the following
# parameters: maxConnections (except for regional managed instance groups),
# maxConnectionsPerInstance, or maxConnectionsPerEndpoint.
# If the loadBalancingScheme for the backend service is INTERNAL (internal TCP/
# UDP load balancers), you cannot specify any additional parameters.
#
# - If the load balancing mode is RATE, the load is spread based on the rate of
# HTTP requests per second (RPS).
# You can use the RATE balancing mode if the protocol for the backend service is
# HTTP or HTTPS. You must specify exactly one of the following parameters:
# maxRate (except for regional managed instance groups), maxRatePerInstance, or
# maxRatePerEndpoint.
#
# - If the load balancing mode is UTILIZATION, the load is spread based on the
# backend utilization of instances in an instance group.
# You can use the UTILIZATION balancing mode if the loadBalancingScheme of the
# backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED and
# the backends are instance groups. There are no restrictions on the backend
# service protocol.
# Corresponds to the JSON property `balancingMode`
# @return [String]
attr_accessor :balancing_mode
# A multiplier applied to the group's maximum servicing capacity (based on
# UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group
# will serve 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. Valid range is 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.
# This cannot be used for internal load balancing.
# Corresponds to the JSON property `capacityScaler`
# @return [Float]
attr_accessor :capacity_scaler
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# This field designates whether this is a failover backend. More than one
# failover backend can be configured for a given BackendService.
# Corresponds to the JSON property `failover`
# @return [Boolean]
attr_accessor :failover
alias_method :failover?, :failover
# The fully-qualified URL of an instance group or network endpoint group (NEG)
# resource. The type of backend that a backend service supports depends on the
# backend service's loadBalancingScheme.
#
# - When the loadBalancingScheme for the backend service is EXTERNAL,
# INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the backend can be either an
# instance group or a NEG. The backends on the backend service must be either
# all instance groups or all NEGs. You cannot mix instance group and NEG
# backends on the same backend service.
# - When the loadBalancingScheme for the backend service is INTERNAL, the
# backend must be an instance group in the same region as the backend service.
# NEGs are not supported.
# 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.
# Corresponds to the JSON property `group`
# @return [String]
attr_accessor :group
# Defines a target maximum number of simultaneous connections that the backend
# can handle. Valid for network endpoint group and instance group backends (
# except for regional managed instance groups). If the backend's balancingMode
# is UTILIZATION, this is an optional parameter. If the backend's balancingMode
# is CONNECTION, and backend is attached to a backend service whose
# loadBalancingScheme is EXTERNAL, you must specify either this parameter,
# maxConnectionsPerInstance, or maxConnectionsPerEndpoint.
# Not available if the backend's balancingMode is RATE. If the
# loadBalancingScheme is INTERNAL, then maxConnections is not supported, even
# though the backend requires a balancing mode of CONNECTION.
# Corresponds to the JSON property `maxConnections`
# @return [Fixnum]
attr_accessor :max_connections
# Defines a target maximum number of simultaneous connections for an endpoint of
# a NEG. This is multiplied by the number of endpoints in the NEG to implicitly
# calculate a maximum number of target maximum simultaneous connections for the
# NEG. If the backend's balancingMode is CONNECTION, and the backend is attached
# to a backend service whose loadBalancingScheme is EXTERNAL, you must specify
# either this parameter, maxConnections, or maxConnectionsPerInstance.
# Not available if the backend's balancingMode is RATE. Internal TCP/UDP load
# balancing does not support setting maxConnectionsPerEndpoint even though its
# backends require a balancing mode of CONNECTION.
# Corresponds to the JSON property `maxConnectionsPerEndpoint`
# @return [Fixnum]
attr_accessor :max_connections_per_endpoint
# Defines a target maximum number of simultaneous connections for a single VM in
# a backend instance group. This is multiplied by the number of instances in the
# instance group to implicitly calculate a target maximum number of simultaneous
# connections for the whole instance group. If the backend's balancingMode is
# UTILIZATION, this is an optional parameter. If the backend's balancingMode is
# CONNECTION, and backend is attached to a backend service whose
# loadBalancingScheme is EXTERNAL, you must specify either this parameter,
# maxConnections, or maxConnectionsPerEndpoint.
# Not available if the backend's balancingMode is RATE. Internal TCP/UDP load
# balancing does not support setting maxConnectionsPerInstance even though its
# backends require a balancing mode of CONNECTION.
# Corresponds to the JSON property `maxConnectionsPerInstance`
# @return [Fixnum]
attr_accessor :max_connections_per_instance
# Defines a maximum number of HTTP requests per second (RPS) that the backend
# can handle. Valid for network endpoint group and instance group backends (
# except for regional managed instance groups). Must not be defined if the
# backend is a managed instance group that uses autoscaling based on load
# balancing.
# If the backend's balancingMode is UTILIZATION, this is an optional parameter.
# If the backend's balancingMode is RATE, you must specify maxRate,
# maxRatePerInstance, or maxRatePerEndpoint.
# Not available if the backend's balancingMode is CONNECTION.
# Corresponds to the JSON property `maxRate`
# @return [Fixnum]
attr_accessor :max_rate
# Defines a maximum target for requests per second (RPS) for an endpoint of a
# NEG. This is multiplied by the number of endpoints in the NEG to implicitly
# calculate a target maximum rate for the NEG.
# If the backend's balancingMode is RATE, you must specify either this parameter,
# maxRate (except for regional managed instance groups), or maxRatePerInstance.
# Not available if the backend's balancingMode is CONNECTION.
# Corresponds to the JSON property `maxRatePerEndpoint`
# @return [Float]
attr_accessor :max_rate_per_endpoint
# Defines a maximum target for requests per second (RPS) for a single VM in a
# backend instance group. This is multiplied by the number of instances in the
# instance group to implicitly calculate a target maximum rate for the whole
# instance group.
# If the backend's balancingMode is UTILIZATION, this is an optional parameter.
# If the backend's balancingMode is RATE, you must specify either this parameter,
# maxRate (except for regional managed instance groups), or maxRatePerEndpoint.
# Not available if the backend's balancingMode is CONNECTION.
# Corresponds to the JSON property `maxRatePerInstance`
# @return [Float]
attr_accessor :max_rate_per_instance
# Defines the maximum average backend utilization of a backend VM in an instance
# group. The valid range is [0.0, 1.0]. This is an optional parameter if the
# backend's balancingMode is UTILIZATION.
# This parameter can be used in conjunction with maxRate, maxRatePerInstance,
# maxConnections (except for regional managed instance groups), or
# maxConnectionsPerInstance.
# Corresponds to the JSON property `maxUtilization`
# @return [Float]
attr_accessor :max_utilization
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@balancing_mode = args[:balancing_mode] if args.key?(:balancing_mode)
@capacity_scaler = args[:capacity_scaler] if args.key?(:capacity_scaler)
@description = args[:description] if args.key?(:description)
@failover = args[:failover] if args.key?(:failover)
@group = args[:group] if args.key?(:group)
@max_connections = args[:max_connections] if args.key?(:max_connections)
@max_connections_per_endpoint = args[:max_connections_per_endpoint] if args.key?(:max_connections_per_endpoint)
@max_connections_per_instance = args[:max_connections_per_instance] if args.key?(:max_connections_per_instance)
@max_rate = args[:max_rate] if args.key?(:max_rate)
@max_rate_per_endpoint = args[:max_rate_per_endpoint] if args.key?(:max_rate_per_endpoint)
@max_rate_per_instance = args[:max_rate_per_instance] if args.key?(:max_rate_per_instance)
@max_utilization = args[:max_utilization] if args.key?(:max_utilization)
end
end
# Represents a Cloud Storage Bucket resource.
# This Cloud Storage bucket resource is referenced by a URL map of a load
# balancer. For more information, read Backend Buckets.
class BackendBucket
include Google::Apis::Core::Hashable
# Cloud Storage bucket name.
# Corresponds to the JSON property `bucketName`
# @return [String]
attr_accessor :bucket_name
# Message containing Cloud CDN configuration for a backend bucket.
# Corresponds to the JSON property `cdnPolicy`
# @return [Google::Apis::ComputeV1::BackendBucketCdnPolicy]
attr_accessor :cdn_policy
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional textual description of the resource; provided by the client when
# the resource is created.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# If true, enable Cloud CDN for this BackendBucket.
# Corresponds to the JSON property `enableCdn`
# @return [Boolean]
attr_accessor :enable_cdn
alias_method :enable_cdn?, :enable_cdn
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# Type of the resource.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@bucket_name = args[:bucket_name] if args.key?(:bucket_name)
@cdn_policy = args[:cdn_policy] if args.key?(:cdn_policy)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@enable_cdn = args[:enable_cdn] if args.key?(:enable_cdn)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@self_link = args[:self_link] if args.key?(:self_link)
end
end
# Message containing Cloud CDN configuration for a backend bucket.
class BackendBucketCdnPolicy
include Google::Apis::Core::Hashable
# 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.
# Corresponds to the JSON property `signedUrlCacheMaxAgeSec`
# @return [Fixnum]
attr_accessor :signed_url_cache_max_age_sec
# [Output Only] Names of the keys for signing request URLs.
# Corresponds to the JSON property `signedUrlKeyNames`
# @return [Array<String>]
attr_accessor :signed_url_key_names
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@signed_url_cache_max_age_sec = args[:signed_url_cache_max_age_sec] if args.key?(:signed_url_cache_max_age_sec)
@signed_url_key_names = args[:signed_url_key_names] if args.key?(:signed_url_key_names)
end
end
# Contains a list of BackendBucket resources.
class BackendBucketList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of BackendBucket resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::BackendBucket>]
attr_accessor :items
# Type of resource.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::BackendBucketList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::BackendBucketList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Represents a Backend Service resource.
# A backend service defines how Google Cloud load balancers distribute traffic.
# The backend service configuration contains a set of values, such as the
# protocol used to connect to backends, various distribution and session
# settings, health checks, and timeouts. These settings provide fine-grained
# control over how your load balancer behaves. Most of the settings have default
# values that allow for easy configuration if you need to get started quickly.
# Backend services in Google Compute Engine can be either regionally or globally
# scoped.
# * [Global](/compute/docs/reference/rest/`$api_version`/backendServices) * [
# Regional](/compute/docs/reference/rest/`$api_version`/regionBackendServices)
# For more information, see Backend Services.
# (== resource_for `$api_version`.backendService ==)
class BackendService
include Google::Apis::Core::Hashable
# 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 one day (86,400).
# Corresponds to the JSON property `affinityCookieTtlSec`
# @return [Fixnum]
attr_accessor :affinity_cookie_ttl_sec
# The list of backends that serve this BackendService.
# Corresponds to the JSON property `backends`
# @return [Array<Google::Apis::ComputeV1::Backend>]
attr_accessor :backends
# Message containing Cloud CDN configuration for a backend service.
# Corresponds to the JSON property `cdnPolicy`
# @return [Google::Apis::ComputeV1::BackendServiceCdnPolicy]
attr_accessor :cdn_policy
# Settings controlling the volume of connections to a backend service.
# Corresponds to the JSON property `circuitBreakers`
# @return [Google::Apis::ComputeV1::CircuitBreakers]
attr_accessor :circuit_breakers
# Message containing connection draining configuration.
# Corresponds to the JSON property `connectionDraining`
# @return [Google::Apis::ComputeV1::ConnectionDraining]
attr_accessor :connection_draining
# This message defines settings for a consistent hash style load balancer.
# Corresponds to the JSON property `consistentHash`
# @return [Google::Apis::ComputeV1::ConsistentHashLoadBalancerSettings]
attr_accessor :consistent_hash
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# Headers that the HTTP/S load balancer should add to proxied requests.
# Corresponds to the JSON property `customRequestHeaders`
# @return [Array<String>]
attr_accessor :custom_request_headers
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# If true, enables Cloud CDN for the backend service. Only applicable if the
# loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS.
# Corresponds to the JSON property `enableCDN`
# @return [Boolean]
attr_accessor :enable_cdn
alias_method :enable_cdn?, :enable_cdn
# Applicable only to Failover for Internal TCP/UDP Load Balancing. On failover
# or failback, this field indicates whether connection draining will be honored.
# GCP has a fixed connection draining timeout of 10 minutes. A setting of true
# terminates existing TCP connections to the active pool during failover and
# failback, immediately draining traffic. A setting of false allows existing TCP
# connections to persist, even on VMs no longer in the active pool, for up to
# the duration of the connection draining timeout (10 minutes).
# Corresponds to the JSON property `failoverPolicy`
# @return [Google::Apis::ComputeV1::BackendServiceFailoverPolicy]
attr_accessor :failover_policy
# 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.
# Corresponds to the JSON property `fingerprint`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :fingerprint
# 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. Backend services
# with instance group or zonal NEG backends must have a health check. Backend
# services with internet NEG backends must not have a health check. A health
# check must
# Corresponds to the JSON property `healthChecks`
# @return [Array<String>]
attr_accessor :health_checks
# Identity-Aware Proxy
# Corresponds to the JSON property `iap`
# @return [Google::Apis::ComputeV1::BackendServiceIap]
attr_accessor :iap
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] Type of resource. Always compute#backendService for backend
# services.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Specifies the load balancer type. Choose EXTERNAL for load balancers that
# receive traffic from external clients. Choose INTERNAL for Internal TCP/UDP
# Load Balancing. Choose INTERNAL_MANAGED for Internal HTTP(S) Load Balancing.
# Choose INTERNAL_SELF_MANAGED for Traffic Director. A backend service created
# for one type of load balancing cannot be used with another. For more
# information, refer to Choosing a load balancer.
# Corresponds to the JSON property `loadBalancingScheme`
# @return [String]
attr_accessor :load_balancing_scheme
# 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.
# - ORIGINAL_DESTINATION: Backend host is selected based on the client
# connection metadata, i.e., connections are opened to the same address as the
# destination address of the incoming connection before the connection was
# redirected to the load balancer.
# - MAGLEV: used as a drop in replacement for the ring hash load balancer.
# Maglev is not as stable as ring hash but has faster table lookup build times
# and host selection times. For more information about Maglev, see https://ai.
# google/research/pubs/pub44824
# This field is applicable to either:
# - A regional backend service with the service_protocol set to HTTP, HTTPS, or
# HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED.
# - A global backend service with the load_balancing_scheme set to
# INTERNAL_SELF_MANAGED.
# If sessionAffinity is not NONE, and this field is not set to >MAGLEV or
# RING_HASH, session affinity settings will not take effect.
# Corresponds to the JSON property `localityLbPolicy`
# @return [String]
attr_accessor :locality_lb_policy
# The available logging options for the load balancer traffic served by this
# backend service.
# Corresponds to the JSON property `logConfig`
# @return [Google::Apis::ComputeV1::BackendServiceLogConfig]
attr_accessor :log_config
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The URL of the network to which this backend service belongs. This field can
# only be spcified when the load balancing scheme is set to INTERNAL.
# Corresponds to the JSON property `network`
# @return [String]
attr_accessor :network
# Settings controlling the eviction of unhealthy hosts from the load balancing
# pool for the backend service.
# Corresponds to the JSON property `outlierDetection`
# @return [Google::Apis::ComputeV1::OutlierDetection]
attr_accessor :outlier_detection
# Deprecated in favor of portName. The TCP port to connect on the backend. The
# default value is 80.
# This cannot be used if the loadBalancingScheme is INTERNAL (Internal TCP/UDP
# Load Balancing).
# Corresponds to the JSON property `port`
# @return [Fixnum]
attr_accessor :port
# A named port on a backend instance group representing the port for
# communication to the backend VMs in that group. Required when the
# loadBalancingScheme is EXTERNAL, INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED
# and the backends are instance groups. The named port must be defined on each
# backend instance group. This parameter has no meaning if the backends are NEGs.
# Must be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP
# Load Balancing).
# Corresponds to the JSON property `portName`
# @return [String]
attr_accessor :port_name
# The protocol this BackendService uses to communicate with backends.
# Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, or UDP. depending on the
# chosen load balancer or Traffic Director configuration. Refer to the
# documentation for the load balancer or for Traffic Director for more
# information.
# Corresponds to the JSON property `protocol`
# @return [String]
attr_accessor :protocol
# [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.
# Corresponds to the JSON property `region`
# @return [String]
attr_accessor :region
# [Output Only] The resource URL for the security policy associated with this
# backend service.
# Corresponds to the JSON property `securityPolicy`
# @return [String]
attr_accessor :security_policy
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# Type of session affinity to use. The default is NONE. Session affinity is not
# applicable if the --protocol is UDP.
# When the loadBalancingScheme is EXTERNAL, possible values are NONE, CLIENT_IP,
# or GENERATED_COOKIE. You can use GENERATED_COOKIE if the protocol is HTTP or
# HTTPS.
# When the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP,
# CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.
# When the loadBalancingScheme is INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED,
# possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or
# HTTP_COOKIE.
# Corresponds to the JSON property `sessionAffinity`
# @return [String]
attr_accessor :session_affinity
# 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.
# Corresponds to the JSON property `timeoutSec`
# @return [Fixnum]
attr_accessor :timeout_sec
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@affinity_cookie_ttl_sec = args[:affinity_cookie_ttl_sec] if args.key?(:affinity_cookie_ttl_sec)
@backends = args[:backends] if args.key?(:backends)
@cdn_policy = args[:cdn_policy] if args.key?(:cdn_policy)
@circuit_breakers = args[:circuit_breakers] if args.key?(:circuit_breakers)
@connection_draining = args[:connection_draining] if args.key?(:connection_draining)
@consistent_hash = args[:consistent_hash] if args.key?(:consistent_hash)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@custom_request_headers = args[:custom_request_headers] if args.key?(:custom_request_headers)
@description = args[:description] if args.key?(:description)
@enable_cdn = args[:enable_cdn] if args.key?(:enable_cdn)
@failover_policy = args[:failover_policy] if args.key?(:failover_policy)
@fingerprint = args[:fingerprint] if args.key?(:fingerprint)
@health_checks = args[:health_checks] if args.key?(:health_checks)
@iap = args[:iap] if args.key?(:iap)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@load_balancing_scheme = args[:load_balancing_scheme] if args.key?(:load_balancing_scheme)
@locality_lb_policy = args[:locality_lb_policy] if args.key?(:locality_lb_policy)
@log_config = args[:log_config] if args.key?(:log_config)
@name = args[:name] if args.key?(:name)
@network = args[:network] if args.key?(:network)
@outlier_detection = args[:outlier_detection] if args.key?(:outlier_detection)
@port = args[:port] if args.key?(:port)
@port_name = args[:port_name] if args.key?(:port_name)
@protocol = args[:protocol] if args.key?(:protocol)
@region = args[:region] if args.key?(:region)
@security_policy = args[:security_policy] if args.key?(:security_policy)
@self_link = args[:self_link] if args.key?(:self_link)
@session_affinity = args[:session_affinity] if args.key?(:session_affinity)
@timeout_sec = args[:timeout_sec] if args.key?(:timeout_sec)
end
end
# Contains a list of BackendServicesScopedList.
class BackendServiceAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of BackendServicesScopedList resources.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::BackendServicesScopedList>]
attr_accessor :items
# Type of resource.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::BackendServiceAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::BackendServiceAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Message containing Cloud CDN configuration for a backend service.
class BackendServiceCdnPolicy
include Google::Apis::Core::Hashable
# Message containing what to include in the cache key for a request for Cloud
# CDN.
# Corresponds to the JSON property `cacheKeyPolicy`
# @return [Google::Apis::ComputeV1::CacheKeyPolicy]
attr_accessor :cache_key_policy
# 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.
# Corresponds to the JSON property `signedUrlCacheMaxAgeSec`
# @return [Fixnum]
attr_accessor :signed_url_cache_max_age_sec
# [Output Only] Names of the keys for signing request URLs.
# Corresponds to the JSON property `signedUrlKeyNames`
# @return [Array<String>]
attr_accessor :signed_url_key_names
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@cache_key_policy = args[:cache_key_policy] if args.key?(:cache_key_policy)
@signed_url_cache_max_age_sec = args[:signed_url_cache_max_age_sec] if args.key?(:signed_url_cache_max_age_sec)
@signed_url_key_names = args[:signed_url_key_names] if args.key?(:signed_url_key_names)
end
end
# Applicable only to Failover for Internal TCP/UDP Load Balancing. On failover
# or failback, this field indicates whether connection draining will be honored.
# GCP has a fixed connection draining timeout of 10 minutes. A setting of true
# terminates existing TCP connections to the active pool during failover and
# failback, immediately draining traffic. A setting of false allows existing TCP
# connections to persist, even on VMs no longer in the active pool, for up to
# the duration of the connection draining timeout (10 minutes).
class BackendServiceFailoverPolicy
include Google::Apis::Core::Hashable
# This can be set to true only if the protocol is TCP.
# The default is false.
# Corresponds to the JSON property `disableConnectionDrainOnFailover`
# @return [Boolean]
attr_accessor :disable_connection_drain_on_failover
alias_method :disable_connection_drain_on_failover?, :disable_connection_drain_on_failover
# Applicable only to Failover for Internal TCP/UDP Load Balancing. 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.
# The default is false.
# Corresponds to the JSON property `dropTrafficIfUnhealthy`
# @return [Boolean]
attr_accessor :drop_traffic_if_unhealthy
alias_method :drop_traffic_if_unhealthy?, :drop_traffic_if_unhealthy
# Applicable only to Failover for Internal TCP/UDP Load Balancing. 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.
# Corresponds to the JSON property `failoverRatio`
# @return [Float]
attr_accessor :failover_ratio
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@disable_connection_drain_on_failover = args[:disable_connection_drain_on_failover] if args.key?(:disable_connection_drain_on_failover)
@drop_traffic_if_unhealthy = args[:drop_traffic_if_unhealthy] if args.key?(:drop_traffic_if_unhealthy)
@failover_ratio = args[:failover_ratio] if args.key?(:failover_ratio)
end
end
#
class BackendServiceGroupHealth
include Google::Apis::Core::Hashable
# Metadata defined as annotations on the network endpoint group.
# Corresponds to the JSON property `annotations`
# @return [Hash<String,String>]
attr_accessor :annotations
# Health state of the backend instances or endpoints in requested instance or
# network endpoint group, determined based on configured health checks.
# Corresponds to the JSON property `healthStatus`
# @return [Array<Google::Apis::ComputeV1::HealthStatus>]
attr_accessor :health_status
# [Output Only] Type of resource. Always compute#backendServiceGroupHealth for
# the health of backend services.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@annotations = args[:annotations] if args.key?(:annotations)
@health_status = args[:health_status] if args.key?(:health_status)
@kind = args[:kind] if args.key?(:kind)
end
end
# Identity-Aware Proxy
class BackendServiceIap
include Google::Apis::Core::Hashable
# Whether the serving infrastructure will authenticate and authorize all
# incoming requests. If true, the oauth2ClientId and oauth2ClientSecret fields
# must be non-empty.
# Corresponds to the JSON property `enabled`
# @return [Boolean]
attr_accessor :enabled
alias_method :enabled?, :enabled
# OAuth2 client ID to use for the authentication flow.
# Corresponds to the JSON property `oauth2ClientId`
# @return [String]
attr_accessor :oauth2_client_id
# 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.
# Corresponds to the JSON property `oauth2ClientSecret`
# @return [String]
attr_accessor :oauth2_client_secret
# [Output Only] SHA256 hash value for the field oauth2_client_secret above.
# Corresponds to the JSON property `oauth2ClientSecretSha256`
# @return [String]
attr_accessor :oauth2_client_secret_sha256
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@enabled = args[:enabled] if args.key?(:enabled)
@oauth2_client_id = args[:oauth2_client_id] if args.key?(:oauth2_client_id)
@oauth2_client_secret = args[:oauth2_client_secret] if args.key?(:oauth2_client_secret)
@oauth2_client_secret_sha256 = args[:oauth2_client_secret_sha256] if args.key?(:oauth2_client_secret_sha256)
end
end
# Contains a list of BackendService resources.
class BackendServiceList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of BackendService resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::BackendService>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#backendServiceList for lists of
# backend services.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::BackendServiceList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::BackendServiceList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# The available logging options for the load balancer traffic served by this
# backend service.
class BackendServiceLogConfig
include Google::Apis::Core::Hashable
# This field denotes whether to enable logging for the load balancer traffic
# served by this backend service.
# Corresponds to the JSON property `enable`
# @return [Boolean]
attr_accessor :enable
alias_method :enable?, :enable
# 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.
# Corresponds to the JSON property `sampleRate`
# @return [Float]
attr_accessor :sample_rate
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@enable = args[:enable] if args.key?(:enable)
@sample_rate = args[:sample_rate] if args.key?(:sample_rate)
end
end
#
class BackendServiceReference
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `backendService`
# @return [String]
attr_accessor :backend_service
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@backend_service = args[:backend_service] if args.key?(:backend_service)
end
end
#
class BackendServicesScopedList
include Google::Apis::Core::Hashable
# A list of BackendServices contained in this scope.
# Corresponds to the JSON property `backendServices`
# @return [Array<Google::Apis::ComputeV1::BackendService>]
attr_accessor :backend_services
# Informational warning which replaces the list of backend services when the
# list is empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::BackendServicesScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@backend_services = args[:backend_services] if args.key?(:backend_services)
@warning = args[:warning] if args.key?(:warning)
end
# Informational warning which replaces the list of backend services when the
# list is empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::BackendServicesScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Associates `members` with a `role`.
class Binding
include Google::Apis::Core::Hashable
# Represents a textual expression in the Common Expression Language (CEL) syntax.
# CEL is a C-like expression language. The syntax and semantics of CEL are
# documented at https://github.com/google/cel-spec.
# Example (Comparison):
# title: "Summary size limit" description: "Determines if a summary is less than
# 100 chars" expression: "document.summary.size() < 100"
# Example (Equality):
# title: "Requestor is owner" description: "Determines if requestor is the
# document owner" expression: "document.owner == request.auth.claims.email"
# Example (Logic):
# title: "Public documents" description: "Determine whether the document should
# be publicly visible" expression: "document.type != 'private' && document.type !
# = 'internal'"
# Example (Data Manipulation):
# title: "Notification string" description: "Create a notification string with a
# timestamp." expression: "'New message received at ' + string(document.
# create_time)"
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service documentation
# for additional information.
# Corresponds to the JSON property `condition`
# @return [Google::Apis::ComputeV1::Expr]
attr_accessor :condition
# Specifies the identities requesting access for a Cloud Platform resource. `
# members` can have the following values:
# * `allUsers`: A special identifier that represents anyone who is on the
# internet; with or without a Google account.
# * `allAuthenticatedUsers`: A special identifier that represents anyone who is
# authenticated with a Google account or a service account.
# * `user:`emailid``: An email address that represents a specific Google account.
# For example, `alice@example.com` .
# * `serviceAccount:`emailid``: An email address that represents a service
# account. For example, `my-other-app@appspot.gserviceaccount.com`.
# * `group:`emailid``: An email address that represents a Google group. For
# example, `admins@example.com`.
# * `deleted:user:`emailid`?uid=`uniqueid``: An email address (plus unique
# identifier) representing a user that has been recently deleted. For example, `
# alice@example.com?uid=123456789012345678901`. If the user is recovered, this
# value reverts to `user:`emailid`` and the recovered user retains the role in
# the binding.
# * `deleted:serviceAccount:`emailid`?uid=`uniqueid``: An email address (plus
# unique identifier) representing a service account that has been recently
# deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=
# 123456789012345678901`. If the service account is undeleted, this value
# reverts to `serviceAccount:`emailid`` and the undeleted service account
# retains the role in the binding.
# * `deleted:group:`emailid`?uid=`uniqueid``: An email address (plus unique
# identifier) representing a Google group that has been recently deleted. For
# example, `admins@example.com?uid=123456789012345678901`. If the group is
# recovered, this value reverts to `group:`emailid`` and the recovered group
# retains the role in the binding.
# * `domain:`domain``: The G Suite domain (primary) that represents all the
# users of that domain. For example, `google.com` or `example.com`.
# Corresponds to the JSON property `members`
# @return [Array<String>]
attr_accessor :members
# Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`
# , or `roles/owner`.
# Corresponds to the JSON property `role`
# @return [String]
attr_accessor :role
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@condition = args[:condition] if args.key?(:condition)
@members = args[:members] if args.key?(:members)
@role = args[:role] if args.key?(:role)
end
end
#
class CacheInvalidationRule
include Google::Apis::Core::Hashable
# If set, this invalidation rule will only apply to requests with a Host header
# matching host.
# Corresponds to the JSON property `host`
# @return [String]
attr_accessor :host
#
# Corresponds to the JSON property `path`
# @return [String]
attr_accessor :path
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@host = args[:host] if args.key?(:host)
@path = args[:path] if args.key?(:path)
end
end
# Message containing what to include in the cache key for a request for Cloud
# CDN.
class CacheKeyPolicy
include Google::Apis::Core::Hashable
# If true, requests to different hosts will be cached separately.
# Corresponds to the JSON property `includeHost`
# @return [Boolean]
attr_accessor :include_host
alias_method :include_host?, :include_host
# If true, http and https requests will be cached separately.
# Corresponds to the JSON property `includeProtocol`
# @return [Boolean]
attr_accessor :include_protocol
alias_method :include_protocol?, :include_protocol
# 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.
# Corresponds to the JSON property `includeQueryString`
# @return [Boolean]
attr_accessor :include_query_string
alias_method :include_query_string?, :include_query_string
# 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.
# Corresponds to the JSON property `queryStringBlacklist`
# @return [Array<String>]
attr_accessor :query_string_blacklist
# 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.
# Corresponds to the JSON property `queryStringWhitelist`
# @return [Array<String>]
attr_accessor :query_string_whitelist
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@include_host = args[:include_host] if args.key?(:include_host)
@include_protocol = args[:include_protocol] if args.key?(:include_protocol)
@include_query_string = args[:include_query_string] if args.key?(:include_query_string)
@query_string_blacklist = args[:query_string_blacklist] if args.key?(:query_string_blacklist)
@query_string_whitelist = args[:query_string_whitelist] if args.key?(:query_string_whitelist)
end
end
# Settings controlling the volume of connections to a backend service.
class CircuitBreakers
include Google::Apis::Core::Hashable
# The maximum number of connections to the backend service. If not specified,
# there is no limit.
# Corresponds to the JSON property `maxConnections`
# @return [Fixnum]
attr_accessor :max_connections
# The maximum number of pending requests allowed to the backend service. If not
# specified, there is no limit.
# Corresponds to the JSON property `maxPendingRequests`
# @return [Fixnum]
attr_accessor :max_pending_requests
# The maximum number of parallel requests that allowed to the backend service.
# If not specified, there is no limit.
# Corresponds to the JSON property `maxRequests`
# @return [Fixnum]
attr_accessor :max_requests
# 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.
# Corresponds to the JSON property `maxRequestsPerConnection`
# @return [Fixnum]
attr_accessor :max_requests_per_connection
# The maximum number of parallel retries allowed to the backend cluster. If not
# specified, the default is 1.
# Corresponds to the JSON property `maxRetries`
# @return [Fixnum]
attr_accessor :max_retries
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@max_connections = args[:max_connections] if args.key?(:max_connections)
@max_pending_requests = args[:max_pending_requests] if args.key?(:max_pending_requests)
@max_requests = args[:max_requests] if args.key?(:max_requests)
@max_requests_per_connection = args[:max_requests_per_connection] if args.key?(:max_requests_per_connection)
@max_retries = args[:max_retries] if args.key?(:max_retries)
end
end
# Represents a regional Commitment resource.
# Creating a commitment resource means that you are purchasing a committed use
# contract with an explicit start and end time. You can create commitments based
# on vCPUs and memory usage and receive discounted rates. For full details, read
# Signing Up for Committed Use Discounts. (== resource_for `$api_version`.
# regionCommitments ==)
class Commitment
include Google::Apis::Core::Hashable
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] Commitment end time in RFC3339 text format.
# Corresponds to the JSON property `endTimestamp`
# @return [String]
attr_accessor :end_timestamp
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] Type of the resource. Always compute#commitment for commitments.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The plan for this commitment, which determines duration and discount rate. The
# currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3
# years).
# Corresponds to the JSON property `plan`
# @return [String]
attr_accessor :plan
# [Output Only] URL of the region where this commitment may be used.
# Corresponds to the JSON property `region`
# @return [String]
attr_accessor :region
# List of reservations in this commitment.
# Corresponds to the JSON property `reservations`
# @return [Array<Google::Apis::ComputeV1::Reservation>]
attr_accessor :reservations
# A list of commitment amounts for particular resources. Note that VCPU and
# MEMORY resource commitments must occur together.
# Corresponds to the JSON property `resources`
# @return [Array<Google::Apis::ComputeV1::ResourceCommitment>]
attr_accessor :resources
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Commitment start time in RFC3339 text format.
# Corresponds to the JSON property `startTimestamp`
# @return [String]
attr_accessor :start_timestamp
# [Output Only] Status of the commitment with regards to eventual expiration (
# each commitment has an end date defined). One of the following values:
# NOT_YET_ACTIVE, ACTIVE, EXPIRED.
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
# [Output Only] An optional, human-readable explanation of the status.
# Corresponds to the JSON property `statusMessage`
# @return [String]
attr_accessor :status_message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@end_timestamp = args[:end_timestamp] if args.key?(:end_timestamp)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@plan = args[:plan] if args.key?(:plan)
@region = args[:region] if args.key?(:region)
@reservations = args[:reservations] if args.key?(:reservations)
@resources = args[:resources] if args.key?(:resources)
@self_link = args[:self_link] if args.key?(:self_link)
@start_timestamp = args[:start_timestamp] if args.key?(:start_timestamp)
@status = args[:status] if args.key?(:status)
@status_message = args[:status_message] if args.key?(:status_message)
end
end
#
class CommitmentAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of CommitmentsScopedList resources.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::CommitmentsScopedList>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#commitmentAggregatedList for
# aggregated lists of commitments.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::CommitmentAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::CommitmentAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Contains a list of Commitment resources.
class CommitmentList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of Commitment resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::Commitment>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#commitmentList for lists of
# commitments.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::CommitmentList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::CommitmentList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class CommitmentsScopedList
include Google::Apis::Core::Hashable
# [Output Only] A list of commitments contained in this scope.
# Corresponds to the JSON property `commitments`
# @return [Array<Google::Apis::ComputeV1::Commitment>]
attr_accessor :commitments
# [Output Only] Informational warning which replaces the list of commitments
# when the list is empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::CommitmentsScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@commitments = args[:commitments] if args.key?(:commitments)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning which replaces the list of commitments
# when the list is empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::CommitmentsScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# A condition to be met.
class Condition
include Google::Apis::Core::Hashable
# Trusted attributes supplied by the IAM system.
# Corresponds to the JSON property `iam`
# @return [String]
attr_accessor :iam
# An operator to apply the subject with.
# Corresponds to the JSON property `op`
# @return [String]
attr_accessor :op
# Trusted attributes discharged by the service.
# Corresponds to the JSON property `svc`
# @return [String]
attr_accessor :svc
# Trusted attributes supplied by any service that owns resources and uses the
# IAM system for access control.
# Corresponds to the JSON property `sys`
# @return [String]
attr_accessor :sys
# The objects of the condition.
# Corresponds to the JSON property `values`
# @return [Array<String>]
attr_accessor :values
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@iam = args[:iam] if args.key?(:iam)
@op = args[:op] if args.key?(:op)
@svc = args[:svc] if args.key?(:svc)
@sys = args[:sys] if args.key?(:sys)
@values = args[:values] if args.key?(:values)
end
end
# Message containing connection draining configuration.
class ConnectionDraining
include Google::Apis::Core::Hashable
# The amount of time in seconds to allow existing connections to persist while
# on unhealthy backend VMs. Only applicable if the protocol is not UDP. The
# valid range is [0, 3600].
# Corresponds to the JSON property `drainingTimeoutSec`
# @return [Fixnum]
attr_accessor :draining_timeout_sec
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@draining_timeout_sec = args[:draining_timeout_sec] if args.key?(:draining_timeout_sec)
end
end
# This message defines settings for a consistent hash style load balancer.
class ConsistentHashLoadBalancerSettings
include Google::Apis::Core::Hashable
# The information about the HTTP Cookie on which the hash function is based for
# load balancing policies that use a consistent hash.
# Corresponds to the JSON property `httpCookie`
# @return [Google::Apis::ComputeV1::ConsistentHashLoadBalancerSettingsHttpCookie]
attr_accessor :http_cookie
# The hash based on the value of the specified header field. This field is
# applicable if the sessionAffinity is set to HEADER_FIELD.
# Corresponds to the JSON property `httpHeaderName`
# @return [String]
attr_accessor :http_header_name
# 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.
# Corresponds to the JSON property `minimumRingSize`
# @return [Fixnum]
attr_accessor :minimum_ring_size
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@http_cookie = args[:http_cookie] if args.key?(:http_cookie)
@http_header_name = args[:http_header_name] if args.key?(:http_header_name)
@minimum_ring_size = args[:minimum_ring_size] if args.key?(:minimum_ring_size)
end
end
# The information about the HTTP Cookie on which the hash function is based for
# load balancing policies that use a consistent hash.
class ConsistentHashLoadBalancerSettingsHttpCookie
include Google::Apis::Core::Hashable
# Name of the cookie.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Path to set for the cookie.
# Corresponds to the JSON property `path`
# @return [String]
attr_accessor :path
# A Duration represents a fixed-length span of time represented as a count of
# seconds and fractions of seconds at nanosecond resolution. It is independent
# of any calendar and concepts like "day" or "month". Range is approximately 10,
# 000 years.
# Corresponds to the JSON property `ttl`
# @return [Google::Apis::ComputeV1::Duration]
attr_accessor :ttl
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@name = args[:name] if args.key?(:name)
@path = args[:path] if args.key?(:path)
@ttl = args[:ttl] if args.key?(:ttl)
end
end
# The specification for allowing client side cross-origin requests. Please see
# W3C Recommendation for Cross Origin Resource Sharing
class CorsPolicy
include Google::Apis::Core::Hashable
# In response to a preflight request, setting this to true indicates that the
# actual request can include user credentials. This translates to the Access-
# Control-Allow-Credentials header.
# Default is false.
# Corresponds to the JSON property `allowCredentials`
# @return [Boolean]
attr_accessor :allow_credentials
alias_method :allow_credentials?, :allow_credentials
# Specifies the content for the Access-Control-Allow-Headers header.
# Corresponds to the JSON property `allowHeaders`
# @return [Array<String>]
attr_accessor :allow_headers
# Specifies the content for the Access-Control-Allow-Methods header.
# Corresponds to the JSON property `allowMethods`
# @return [Array<String>]
attr_accessor :allow_methods
# Specifies the regualar expression patterns that match allowed origins. For
# regular expression grammar please see en.cppreference.com/w/cpp/regex/
# ecmascript
# An origin is allowed if it matches either an item in allowOrigins or an item
# in allowOriginRegexes.
# Corresponds to the JSON property `allowOriginRegexes`
# @return [Array<String>]
attr_accessor :allow_origin_regexes
# Specifies the list of origins that will be allowed to do CORS requests.
# An origin is allowed if it matches either an item in allowOrigins or an item
# in allowOriginRegexes.
# Corresponds to the JSON property `allowOrigins`
# @return [Array<String>]
attr_accessor :allow_origins
# If true, specifies the CORS policy is disabled. The default value of false,
# which indicates that the CORS policy is in effect.
# Corresponds to the JSON property `disabled`
# @return [Boolean]
attr_accessor :disabled
alias_method :disabled?, :disabled
# Specifies the content for the Access-Control-Expose-Headers header.
# Corresponds to the JSON property `exposeHeaders`
# @return [Array<String>]
attr_accessor :expose_headers
# Specifies how long results of a preflight request can be cached in seconds.
# This translates to the Access-Control-Max-Age header.
# Corresponds to the JSON property `maxAge`
# @return [Fixnum]
attr_accessor :max_age
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@allow_credentials = args[:allow_credentials] if args.key?(:allow_credentials)
@allow_headers = args[:allow_headers] if args.key?(:allow_headers)
@allow_methods = args[:allow_methods] if args.key?(:allow_methods)
@allow_origin_regexes = args[:allow_origin_regexes] if args.key?(:allow_origin_regexes)
@allow_origins = args[:allow_origins] if args.key?(:allow_origins)
@disabled = args[:disabled] if args.key?(:disabled)
@expose_headers = args[:expose_headers] if args.key?(:expose_headers)
@max_age = args[:max_age] if args.key?(:max_age)
end
end
# Represents a customer-supplied encryption key
class CustomerEncryptionKey
include Google::Apis::Core::Hashable
# The name of the encryption key that is stored in Google Cloud KMS.
# Corresponds to the JSON property `kmsKeyName`
# @return [String]
attr_accessor :kms_key_name
# The service account being used for the encryption request for the given KMS
# key. If absent, the Compute Engine default service account is used.
# Corresponds to the JSON property `kmsKeyServiceAccount`
# @return [String]
attr_accessor :kms_key_service_account
# Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648
# base64 to either encrypt or decrypt this resource.
# Corresponds to the JSON property `rawKey`
# @return [String]
attr_accessor :raw_key
# [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-
# supplied encryption key that protects this resource.
# Corresponds to the JSON property `sha256`
# @return [String]
attr_accessor :sha256
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
@kms_key_service_account = args[:kms_key_service_account] if args.key?(:kms_key_service_account)
@raw_key = args[:raw_key] if args.key?(:raw_key)
@sha256 = args[:sha256] if args.key?(:sha256)
end
end
#
class CustomerEncryptionKeyProtectedDisk
include Google::Apis::Core::Hashable
# Represents a customer-supplied encryption key
# Corresponds to the JSON property `diskEncryptionKey`
# @return [Google::Apis::ComputeV1::CustomerEncryptionKey]
attr_accessor :disk_encryption_key
# Specifies a valid partial or full URL to an existing Persistent Disk resource.
# This field is only applicable for persistent disks.
# Corresponds to the JSON property `source`
# @return [String]
attr_accessor :source
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@disk_encryption_key = args[:disk_encryption_key] if args.key?(:disk_encryption_key)
@source = args[:source] if args.key?(:source)
end
end
# Deprecation status for a public resource.
class DeprecationStatus
include Google::Apis::Core::Hashable
# An optional RFC3339 timestamp on or after which the state of this resource is
# intended to change to DELETED. This is only informational and the status will
# not change unless the client explicitly changes it.
# Corresponds to the JSON property `deleted`
# @return [String]
attr_accessor :deleted
# An optional RFC3339 timestamp on or after which the state of this resource is
# intended to change to DEPRECATED. This is only informational and the status
# will not change unless the client explicitly changes it.
# Corresponds to the JSON property `deprecated`
# @return [String]
attr_accessor :deprecated
# An optional RFC3339 timestamp on or after which the state of this resource is
# intended to change to OBSOLETE. This is only informational and the status will
# not change unless the client explicitly changes it.
# Corresponds to the JSON property `obsolete`
# @return [String]
attr_accessor :obsolete
# The URL of the suggested replacement for a deprecated resource. The suggested
# replacement resource must be the same kind of resource as the deprecated
# resource.
# Corresponds to the JSON property `replacement`
# @return [String]
attr_accessor :replacement
# The deprecation state of this resource. This can be ACTIVE, DEPRECATED,
# OBSOLETE, or DELETED. Operations which communicate the end of life date for an
# image, can use ACTIVE. Operations which create a new resource using a
# DEPRECATED resource will return successfully, but with a warning indicating
# the deprecated resource and recommending its replacement. Operations which use
# OBSOLETE or DELETED resources will be rejected and result in an error.
# Corresponds to the JSON property `state`
# @return [String]
attr_accessor :state
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@deleted = args[:deleted] if args.key?(:deleted)
@deprecated = args[:deprecated] if args.key?(:deprecated)
@obsolete = args[:obsolete] if args.key?(:obsolete)
@replacement = args[:replacement] if args.key?(:replacement)
@state = args[:state] if args.key?(:state)
end
end
# Represents a Persistent Disk resource.
# Google Compute Engine has two Disk resources:
# * [Zonal](/compute/docs/reference/rest/`$api_version`/disks) * [Regional](/
# compute/docs/reference/rest/`$api_version`/regionDisks)
# Persistent disks are required for running your VM instances. Create both boot
# and non-boot (data) persistent disks. For more information, read Persistent
# Disks. For more storage options, read Storage options.
# The disks resource represents a zonal persistent disk. For more information,
# read Zonal persistent disks.
# The regionDisks resource represents a regional persistent disk. For more
# information, read Regional resources. (== resource_for `$api_version`.disks ==
# ) (== resource_for `$api_version`.regionDisks ==)
class Disk
include Google::Apis::Core::Hashable
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Represents a customer-supplied encryption key
# Corresponds to the JSON property `diskEncryptionKey`
# @return [Google::Apis::ComputeV1::CustomerEncryptionKey]
attr_accessor :disk_encryption_key
# 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.
# Corresponds to the JSON property `guestOsFeatures`
# @return [Array<Google::Apis::ComputeV1::GuestOsFeature>]
attr_accessor :guest_os_features
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] Type of the resource. Always compute#disk for disks.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# A fingerprint for the labels being applied to this disk, 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 disk.
# Corresponds to the JSON property `labelFingerprint`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :label_fingerprint
# Labels to apply to this disk. These can be later modified by the setLabels
# method.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
# [Output Only] Last attach timestamp in RFC3339 text format.
# Corresponds to the JSON property `lastAttachTimestamp`
# @return [String]
attr_accessor :last_attach_timestamp
# [Output Only] Last detach timestamp in RFC3339 text format.
# Corresponds to the JSON property `lastDetachTimestamp`
# @return [String]
attr_accessor :last_detach_timestamp
# Integer license codes indicating which licenses are attached to this disk.
# Corresponds to the JSON property `licenseCodes`
# @return [Array<Fixnum>]
attr_accessor :license_codes
# A list of publicly visible licenses. Reserved for Google's use.
# Corresponds to the JSON property `licenses`
# @return [Array<String>]
attr_accessor :licenses
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Internal use only.
# Corresponds to the JSON property `options`
# @return [String]
attr_accessor :options
# Physical block size of the persistent disk, in bytes. If not present in a
# request, a default value is used. The currently supported size is 4096, other
# sizes may be added in the future. If an unsupported value is requested, the
# error message will list the supported values for the caller's project.
# Corresponds to the JSON property `physicalBlockSizeBytes`
# @return [Fixnum]
attr_accessor :physical_block_size_bytes
# [Output Only] URL of the region where the disk resides. Only applicable for
# regional resources. You must specify this field as part of the HTTP request
# URL. It is not settable as a field in the request body.
# Corresponds to the JSON property `region`
# @return [String]
attr_accessor :region
# URLs of the zones where the disk should be replicated to. Only applicable for
# regional resources.
# Corresponds to the JSON property `replicaZones`
# @return [Array<String>]
attr_accessor :replica_zones
# Resource policies applied to this disk for automatic snapshot creations.
# Corresponds to the JSON property `resourcePolicies`
# @return [Array<String>]
attr_accessor :resource_policies
# [Output Only] Server-defined fully-qualified URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# Size of the persistent disk, specified in GB. You can specify this field when
# creating a persistent disk using the sourceImage or sourceSnapshot parameter,
# or specify it alone to create an empty persistent disk.
# If you specify this field along with sourceImage or sourceSnapshot, the value
# of sizeGb must not be less than the size of the sourceImage or the size of the
# snapshot. Acceptable values are 1 to 65536, inclusive.
# Corresponds to the JSON property `sizeGb`
# @return [Fixnum]
attr_accessor :size_gb
# The source disk used to create this disk. You can provide this as a partial or
# full URL to the resource. For example, the following are valid values:
# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
# - projects/project/zones/zone/disks/disk
# - zones/zone/disks/disk
# Corresponds to the JSON property `sourceDisk`
# @return [String]
attr_accessor :source_disk
# [Output Only] The unique ID of the disk used to create this disk. This value
# identifies the exact disk that was used to create this persistent disk. For
# example, if you created the persistent disk from a disk that was later deleted
# and recreated under the same name, the source disk ID would identify the exact
# version of the disk that was used.
# Corresponds to the JSON property `sourceDiskId`
# @return [String]
attr_accessor :source_disk_id
# The source image used to create this disk. If the source image is deleted,
# this field will not be set.
# 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 format:
# global/images/my-custom-image
# You can also specify a custom image by its image family, which returns the
# latest version of the image in that family. Replace the image name with family/
# family-name:
# global/images/family/my-image-family
# Corresponds to the JSON property `sourceImage`
# @return [String]
attr_accessor :source_image
# Represents a customer-supplied encryption key
# Corresponds to the JSON property `sourceImageEncryptionKey`
# @return [Google::Apis::ComputeV1::CustomerEncryptionKey]
attr_accessor :source_image_encryption_key
# [Output Only] The ID value of the image used to create this disk. This value
# identifies the exact image that was used to create this persistent disk. For
# example, if you created the persistent disk from an image that was later
# deleted and recreated under the same name, the source image ID would identify
# the exact version of the image that was used.
# Corresponds to the JSON property `sourceImageId`
# @return [String]
attr_accessor :source_image_id
# The source snapshot used to create this disk. You can provide this as a
# partial or full URL to the resource. For example, the following are valid
# values:
# - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/
# snapshot
# - projects/project/global/snapshots/snapshot
# - global/snapshots/snapshot
# Corresponds to the JSON property `sourceSnapshot`
# @return [String]
attr_accessor :source_snapshot
# Represents a customer-supplied encryption key
# Corresponds to the JSON property `sourceSnapshotEncryptionKey`
# @return [Google::Apis::ComputeV1::CustomerEncryptionKey]
attr_accessor :source_snapshot_encryption_key
# [Output Only] The unique ID of the snapshot used to create this disk. This
# value identifies the exact snapshot that was used to create this persistent
# disk. For example, if you created the persistent disk from a snapshot that was
# later deleted and recreated under the same name, the source snapshot ID would
# identify the exact version of the snapshot that was used.
# Corresponds to the JSON property `sourceSnapshotId`
# @return [String]
attr_accessor :source_snapshot_id
# [Output Only] The status of disk creation. CREATING: Disk is provisioning.
# RESTORING: Source data is being copied into the disk. FAILED: Disk creation
# failed. READY: Disk is ready for use. DELETING: Disk is deleting.
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
# URL of the disk type resource describing which disk type to use to create the
# disk. Provide this when creating the disk. For example: projects/project/zones/
# zone/diskTypes/pd-standard or pd-ssd
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
# [Output Only] Links to the users of the disk (attached instances) in form:
# projects/project/zones/zone/instances/instance
# Corresponds to the JSON property `users`
# @return [Array<String>]
attr_accessor :users
# [Output Only] URL of the zone where the disk resides. You must specify this
# field as part of the HTTP request URL. It is not settable as a field in the
# request body.
# Corresponds to the JSON property `zone`
# @return [String]
attr_accessor :zone
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@disk_encryption_key = args[:disk_encryption_key] if args.key?(:disk_encryption_key)
@guest_os_features = args[:guest_os_features] if args.key?(:guest_os_features)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint)
@labels = args[:labels] if args.key?(:labels)
@last_attach_timestamp = args[:last_attach_timestamp] if args.key?(:last_attach_timestamp)
@last_detach_timestamp = args[:last_detach_timestamp] if args.key?(:last_detach_timestamp)
@license_codes = args[:license_codes] if args.key?(:license_codes)
@licenses = args[:licenses] if args.key?(:licenses)
@name = args[:name] if args.key?(:name)
@options = args[:options] if args.key?(:options)
@physical_block_size_bytes = args[:physical_block_size_bytes] if args.key?(:physical_block_size_bytes)
@region = args[:region] if args.key?(:region)
@replica_zones = args[:replica_zones] if args.key?(:replica_zones)
@resource_policies = args[:resource_policies] if args.key?(:resource_policies)
@self_link = args[:self_link] if args.key?(:self_link)
@size_gb = args[:size_gb] if args.key?(:size_gb)
@source_disk = args[:source_disk] if args.key?(:source_disk)
@source_disk_id = args[:source_disk_id] if args.key?(:source_disk_id)
@source_image = args[:source_image] if args.key?(:source_image)
@source_image_encryption_key = args[:source_image_encryption_key] if args.key?(:source_image_encryption_key)
@source_image_id = args[:source_image_id] if args.key?(:source_image_id)
@source_snapshot = args[:source_snapshot] if args.key?(:source_snapshot)
@source_snapshot_encryption_key = args[:source_snapshot_encryption_key] if args.key?(:source_snapshot_encryption_key)
@source_snapshot_id = args[:source_snapshot_id] if args.key?(:source_snapshot_id)
@status = args[:status] if args.key?(:status)
@type = args[:type] if args.key?(:type)
@users = args[:users] if args.key?(:users)
@zone = args[:zone] if args.key?(:zone)
end
end
#
class DiskAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of DisksScopedList resources.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::DisksScopedList>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#diskAggregatedList for
# aggregated lists of persistent disks.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::DiskAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::DiskAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# A specification of the desired way to instantiate a disk in the instance
# template when its created from a source instance.
class DiskInstantiationConfig
include Google::Apis::Core::Hashable
# Specifies whether the disk will be auto-deleted when the instance is deleted (
# but not when the disk is detached from the instance).
# Corresponds to the JSON property `autoDelete`
# @return [Boolean]
attr_accessor :auto_delete
alias_method :auto_delete?, :auto_delete
# The custom source image to be used to restore this disk when instantiating
# this instance template.
# Corresponds to the JSON property `customImage`
# @return [String]
attr_accessor :custom_image
# Specifies the device name of the disk to which the configurations apply to.
# Corresponds to the JSON property `deviceName`
# @return [String]
attr_accessor :device_name
# Specifies whether to include the disk and what image to use. Possible values
# are:
# - source-image: to use the same image that was used to create the source
# instance's corresponding disk. Applicable to the boot disk and additional read-
# write disks.
# - source-image-family: to use the same image family that was used to create
# the source instance's corresponding disk. Applicable to the boot disk and
# additional read-write disks.
# - custom-image: to use a user-provided image url for disk creation. Applicable
# to the boot disk and additional read-write disks.
# - attach-read-only: to attach a read-only disk. Applicable to read-only disks.
# - do-not-include: to exclude a disk from the template. Applicable to
# additional read-write disks, local SSDs, and read-only disks.
# Corresponds to the JSON property `instantiateFrom`
# @return [String]
attr_accessor :instantiate_from
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@auto_delete = args[:auto_delete] if args.key?(:auto_delete)
@custom_image = args[:custom_image] if args.key?(:custom_image)
@device_name = args[:device_name] if args.key?(:device_name)
@instantiate_from = args[:instantiate_from] if args.key?(:instantiate_from)
end
end
# A list of Disk resources.
class DiskList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of Disk resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::Disk>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#diskList for lists of disks.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::DiskList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::DiskList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class MoveDiskRequest
include Google::Apis::Core::Hashable
# The URL of the destination zone to move the disk. This can be a full or
# partial URL. For example, the following are all valid URLs to a zone:
# - https://www.googleapis.com/compute/v1/projects/project/zones/zone
# - projects/project/zones/zone
# - zones/zone
# Corresponds to the JSON property `destinationZone`
# @return [String]
attr_accessor :destination_zone
# The URL of the target disk to move. This can be a full or partial URL. For
# example, the following are all valid URLs to a disk:
# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
# - projects/project/zones/zone/disks/disk
# - zones/zone/disks/disk
# Corresponds to the JSON property `targetDisk`
# @return [String]
attr_accessor :target_disk
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@destination_zone = args[:destination_zone] if args.key?(:destination_zone)
@target_disk = args[:target_disk] if args.key?(:target_disk)
end
end
# Represents a Disk Type resource.
# Google Compute Engine has two Disk Type resources:
# * [Regional](/compute/docs/reference/rest/`$api_version`/regionDiskTypes) * [
# Zonal](/compute/docs/reference/rest/`$api_version`/diskTypes)
# You can choose from a variety of disk types based on your needs. For more
# information, read Storage options.
# The diskTypes resource represents disk types for a zonal persistent disk. For
# more information, read Zonal persistent disks.
# The regionDiskTypes resource represents disk types for a regional persistent
# disk. For more information, read Regional persistent disks. (== resource_for `$
# api_version`.diskTypes ==) (== resource_for `$api_version`.regionDiskTypes ==)
class DiskType
include Google::Apis::Core::Hashable
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# [Output Only] Server-defined default disk size in GB.
# Corresponds to the JSON property `defaultDiskSizeGb`
# @return [Fixnum]
attr_accessor :default_disk_size_gb
# Deprecation status for a public resource.
# Corresponds to the JSON property `deprecated`
# @return [Google::Apis::ComputeV1::DeprecationStatus]
attr_accessor :deprecated
# [Output Only] An optional description of this resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] Type of the resource. Always compute#diskType for disk types.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] Name of the resource.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# [Output Only] URL of the region where the disk type resides. Only applicable
# for regional resources. You must specify this field as part of the HTTP
# request URL. It is not settable as a field in the request body.
# Corresponds to the JSON property `region`
# @return [String]
attr_accessor :region
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] An optional textual description of the valid disk size, such as "
# 10GB-10TB".
# Corresponds to the JSON property `validDiskSize`
# @return [String]
attr_accessor :valid_disk_size
# [Output Only] URL of the zone where the disk type resides. You must specify
# this field as part of the HTTP request URL. It is not settable as a field in
# the request body.
# Corresponds to the JSON property `zone`
# @return [String]
attr_accessor :zone
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@default_disk_size_gb = args[:default_disk_size_gb] if args.key?(:default_disk_size_gb)
@deprecated = args[:deprecated] if args.key?(:deprecated)
@description = args[:description] if args.key?(:description)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@region = args[:region] if args.key?(:region)
@self_link = args[:self_link] if args.key?(:self_link)
@valid_disk_size = args[:valid_disk_size] if args.key?(:valid_disk_size)
@zone = args[:zone] if args.key?(:zone)
end
end
#
class DiskTypeAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of DiskTypesScopedList resources.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::DiskTypesScopedList>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#diskTypeAggregatedList.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::DiskTypeAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::DiskTypeAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Contains a list of disk types.
class DiskTypeList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of DiskType resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::DiskType>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#diskTypeList for disk types.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::DiskTypeList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::DiskTypeList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class DiskTypesScopedList
include Google::Apis::Core::Hashable
# [Output Only] A list of disk types contained in this scope.
# Corresponds to the JSON property `diskTypes`
# @return [Array<Google::Apis::ComputeV1::DiskType>]
attr_accessor :disk_types
# [Output Only] Informational warning which replaces the list of disk types when
# the list is empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::DiskTypesScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@disk_types = args[:disk_types] if args.key?(:disk_types)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning which replaces the list of disk types when
# the list is empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::DiskTypesScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class DisksAddResourcePoliciesRequest
include Google::Apis::Core::Hashable
# Resource policies to be added to this disk. Currently you can only specify one
# policy here.
# Corresponds to the JSON property `resourcePolicies`
# @return [Array<String>]
attr_accessor :resource_policies
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@resource_policies = args[:resource_policies] if args.key?(:resource_policies)
end
end
#
class DisksRemoveResourcePoliciesRequest
include Google::Apis::Core::Hashable
# Resource policies to be removed from this disk.
# Corresponds to the JSON property `resourcePolicies`
# @return [Array<String>]
attr_accessor :resource_policies
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@resource_policies = args[:resource_policies] if args.key?(:resource_policies)
end
end
#
class DisksResizeRequest
include Google::Apis::Core::Hashable
# The new size of the persistent disk, which is specified in GB.
# Corresponds to the JSON property `sizeGb`
# @return [Fixnum]
attr_accessor :size_gb
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@size_gb = args[:size_gb] if args.key?(:size_gb)
end
end
#
class DisksScopedList
include Google::Apis::Core::Hashable
# [Output Only] A list of disks contained in this scope.
# Corresponds to the JSON property `disks`
# @return [Array<Google::Apis::ComputeV1::Disk>]
attr_accessor :disks
# [Output Only] Informational warning which replaces the list of disks when the
# list is empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::DisksScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@disks = args[:disks] if args.key?(:disks)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning which replaces the list of disks when the
# list is empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::DisksScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# A set of Display Device options
class DisplayDevice
include Google::Apis::Core::Hashable
# Defines whether the instance has Display enabled.
# Corresponds to the JSON property `enableDisplay`
# @return [Boolean]
attr_accessor :enable_display
alias_method :enable_display?, :enable_display
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@enable_display = args[:enable_display] if args.key?(:enable_display)
end
end
#
class DistributionPolicy
include Google::Apis::Core::Hashable
# Zones where the regional managed instance group will create and manage
# instances.
# Corresponds to the JSON property `zones`
# @return [Array<Google::Apis::ComputeV1::DistributionPolicyZoneConfiguration>]
attr_accessor :zones
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@zones = args[:zones] if args.key?(:zones)
end
end
#
class DistributionPolicyZoneConfiguration
include Google::Apis::Core::Hashable
# The URL of the zone. The zone must exist in the region where the managed
# instance group is located.
# Corresponds to the JSON property `zone`
# @return [String]
attr_accessor :zone
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@zone = args[:zone] if args.key?(:zone)
end
end
# A Duration represents a fixed-length span of time represented as a count of
# seconds and fractions of seconds at nanosecond resolution. It is independent
# of any calendar and concepts like "day" or "month". Range is approximately 10,
# 000 years.
class Duration
include Google::Apis::Core::Hashable
# 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.
# Corresponds to the JSON property `nanos`
# @return [Fixnum]
attr_accessor :nanos
# 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
# Corresponds to the JSON property `seconds`
# @return [Fixnum]
attr_accessor :seconds
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@nanos = args[:nanos] if args.key?(:nanos)
@seconds = args[:seconds] if args.key?(:seconds)
end
end
#
class ExchangedPeeringRoute
include Google::Apis::Core::Hashable
# The destination range of the route.
# Corresponds to the JSON property `destRange`
# @return [String]
attr_accessor :dest_range
# True if the peering route has been imported from a peer. The actual import
# happens if the field networkPeering.importCustomRoutes is true for this
# network, and networkPeering.exportCustomRoutes is true for the peer network,
# and the import does not result in a route conflict.
# Corresponds to the JSON property `imported`
# @return [Boolean]
attr_accessor :imported
alias_method :imported?, :imported
# The region of peering route next hop, only applies to dynamic routes.
# Corresponds to the JSON property `nextHopRegion`
# @return [String]
attr_accessor :next_hop_region
# The priority of the peering route.
# Corresponds to the JSON property `priority`
# @return [Fixnum]
attr_accessor :priority
# The type of the peering route.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@dest_range = args[:dest_range] if args.key?(:dest_range)
@imported = args[:imported] if args.key?(:imported)
@next_hop_region = args[:next_hop_region] if args.key?(:next_hop_region)
@priority = args[:priority] if args.key?(:priority)
@type = args[:type] if args.key?(:type)
end
end
#
class ExchangedPeeringRoutesList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of ExchangedPeeringRoute resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::ExchangedPeeringRoute>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#exchangedPeeringRoutesList for
# exchanged peering routes lists.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::ExchangedPeeringRoutesList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::ExchangedPeeringRoutesList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Represents a textual expression in the Common Expression Language (CEL) syntax.
# CEL is a C-like expression language. The syntax and semantics of CEL are
# documented at https://github.com/google/cel-spec.
# Example (Comparison):
# title: "Summary size limit" description: "Determines if a summary is less than
# 100 chars" expression: "document.summary.size() < 100"
# Example (Equality):
# title: "Requestor is owner" description: "Determines if requestor is the
# document owner" expression: "document.owner == request.auth.claims.email"
# Example (Logic):
# title: "Public documents" description: "Determine whether the document should
# be publicly visible" expression: "document.type != 'private' && document.type !
# = 'internal'"
# Example (Data Manipulation):
# title: "Notification string" description: "Create a notification string with a
# timestamp." expression: "'New message received at ' + string(document.
# create_time)"
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service documentation
# for additional information.
class Expr
include Google::Apis::Core::Hashable
# Optional. Description of the expression. This is a longer text which describes
# the expression, e.g. when hovered over it in a UI.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Textual representation of an expression in Common Expression Language syntax.
# Corresponds to the JSON property `expression`
# @return [String]
attr_accessor :expression
# Optional. String indicating the location of the expression for error reporting,
# e.g. a file name and a position in the file.
# Corresponds to the JSON property `location`
# @return [String]
attr_accessor :location
# Optional. Title for the expression, i.e. a short string describing its purpose.
# This can be used e.g. in UIs which allow to enter the expression.
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@description = args[:description] if args.key?(:description)
@expression = args[:expression] if args.key?(:expression)
@location = args[:location] if args.key?(:location)
@title = args[:title] if args.key?(:title)
end
end
# Represents an external VPN gateway.
# External VPN gateway is the on-premises VPN gateway(s) or another cloud
# provider's VPN gateway that connects to your Google Cloud VPN gateway.
# To create a highly available VPN from Google Cloud Platform to your VPN
# gateway or another cloud provider's VPN gateway, you must create a external
# VPN gateway resource with information about the other gateway.
# For more information about using external VPN gateways, see Creating an HA
# VPN gateway and tunnel pair to a peer VPN. (== resource_for `$api_version`.
# externalVpnGateways ==)
class ExternalVpnGateway
include Google::Apis::Core::Hashable
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# List of interfaces for this external VPN gateway.
# Corresponds to the JSON property `interfaces`
# @return [Array<Google::Apis::ComputeV1::ExternalVpnGatewayInterface>]
attr_accessor :interfaces
# [Output Only] Type of the resource. Always compute#externalVpnGateway for
# externalVpnGateways.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# A fingerprint for the labels being applied to this ExternalVpnGateway, 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 an
# ExternalVpnGateway.
# Corresponds to the JSON property `labelFingerprint`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :label_fingerprint
# 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.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Indicates the user-supplied redundancy type of this external VPN gateway.
# Corresponds to the JSON property `redundancyType`
# @return [String]
attr_accessor :redundancy_type
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@id = args[:id] if args.key?(:id)
@interfaces = args[:interfaces] if args.key?(:interfaces)
@kind = args[:kind] if args.key?(:kind)
@label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint)
@labels = args[:labels] if args.key?(:labels)
@name = args[:name] if args.key?(:name)
@redundancy_type = args[:redundancy_type] if args.key?(:redundancy_type)
@self_link = args[:self_link] if args.key?(:self_link)
end
end
# The interface for the external VPN gateway.
class ExternalVpnGatewayInterface
include Google::Apis::Core::Hashable
# The numeric ID of this interface. The allowed input values for this id for
# different redundancy types of external VPN gateway:
# SINGLE_IP_INTERNALLY_REDUNDANT - 0 TWO_IPS_REDUNDANCY - 0, 1
# FOUR_IPS_REDUNDANCY - 0, 1, 2, 3
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# IP address of the interface in the external VPN gateway. Only IPv4 is
# supported. This IP address can be either from your on-premise gateway or
# another Cloud provider's VPN gateway, it cannot be an IP address from Google
# Compute Engine.
# Corresponds to the JSON property `ipAddress`
# @return [String]
attr_accessor :ip_address
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@ip_address = args[:ip_address] if args.key?(:ip_address)
end
end
# Response to the list request, and contains a list of externalVpnGateways.
class ExternalVpnGatewayList
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `etag`
# @return [String]
attr_accessor :etag
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of ExternalVpnGateway resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::ExternalVpnGateway>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#externalVpnGatewayList for
# lists of externalVpnGateways.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::ExternalVpnGatewayList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@etag = args[:etag] if args.key?(:etag)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::ExternalVpnGatewayList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class FileContentBuffer
include Google::Apis::Core::Hashable
# The raw content in the secure keys file.
# Corresponds to the JSON property `content`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :content
# The file type of source file.
# Corresponds to the JSON property `fileType`
# @return [String]
attr_accessor :file_type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@content = args[:content] if args.key?(:content)
@file_type = args[:file_type] if args.key?(:file_type)
end
end
# Represents a Firewall Rule resource.
# Firewall rules allow or deny ingress traffic to, and egress traffic from your
# instances. For more information, read Firewall rules.
class Firewall
include Google::Apis::Core::Hashable
# The list of ALLOW rules specified by this firewall. Each rule specifies a
# protocol and port-range tuple that describes a permitted connection.
# Corresponds to the JSON property `allowed`
# @return [Array<Google::Apis::ComputeV1::Firewall::Allowed>]
attr_accessor :allowed
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# The list of DENY rules specified by this firewall. Each rule specifies a
# protocol and port-range tuple that describes a denied connection.
# Corresponds to the JSON property `denied`
# @return [Array<Google::Apis::ComputeV1::Firewall::Denied>]
attr_accessor :denied
# An optional description of this resource. Provide this field when you create
# the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# If destination ranges are specified, the firewall rule applies only to traffic
# that has destination IP address in these ranges. These ranges must be
# expressed in CIDR format. Only IPv4 is supported.
# Corresponds to the JSON property `destinationRanges`
# @return [Array<String>]
attr_accessor :destination_ranges
# Direction of traffic to which this firewall applies, either `INGRESS` or `
# EGRESS`. The default is `INGRESS`. For `INGRESS` traffic, you cannot specify
# the destinationRanges field, and for `EGRESS` traffic, you cannot specify the
# sourceRanges or sourceTags fields.
# Corresponds to the JSON property `direction`
# @return [String]
attr_accessor :direction
# Denotes whether the firewall rule is disabled. When set to true, the firewall
# rule is not enforced and the network behaves as if it did not exist. If this
# is unspecified, the firewall rule will be enabled.
# Corresponds to the JSON property `disabled`
# @return [Boolean]
attr_accessor :disabled
alias_method :disabled?, :disabled
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] Type of the resource. Always compute#firewall for firewall rules.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# The available logging options for a firewall rule.
# Corresponds to the JSON property `logConfig`
# @return [Google::Apis::ComputeV1::FirewallLogConfig]
attr_accessor :log_config
# 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])?. The first character must be a lowercase letter, and all
# following characters (except for the last character) must be a dash, lowercase
# letter, or digit. The last character must be a lowercase letter or digit.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# URL of the network resource for this firewall rule. If not specified when
# creating a firewall rule, the default network is used:
# global/networks/default
# If you choose to specify this field, 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/myproject/global/networks/my-
# network
# - projects/myproject/global/networks/my-network
# - global/networks/default
# Corresponds to the JSON property `network`
# @return [String]
attr_accessor :network
# Priority for this rule. This is an integer between `0` and `65535`, both
# inclusive. The default value is `1000`. Relative priorities determine which
# rule takes effect if multiple rules apply. Lower values indicate higher
# priority. For example, a rule with priority `0` has higher precedence than a
# rule with priority `1`. DENY rules take precedence over ALLOW rules if they
# have equal priority. Note that VPC networks have implied rules with a priority
# of `65535`. To avoid conflicts with the implied rules, use a priority number
# less than `65535`.
# Corresponds to the JSON property `priority`
# @return [Fixnum]
attr_accessor :priority
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# If source ranges are specified, the firewall rule applies only to traffic that
# has a source IP address in these ranges. These ranges must be expressed in
# CIDR format. One or both of sourceRanges and sourceTags may be set. If both
# fields are set, the rule applies to traffic that has a source IP address
# within sourceRanges OR a source IP from a resource with a matching tag listed
# in the sourceTags field. The connection does not need to match both fields for
# the rule to apply. Only IPv4 is supported.
# Corresponds to the JSON property `sourceRanges`
# @return [Array<String>]
attr_accessor :source_ranges
# If source service accounts are specified, the firewall rules apply only to
# traffic originating from an instance with a service account in this list.
# Source service accounts cannot be used to control traffic to an instance's
# external IP address because service accounts are associated with an instance,
# not an IP address. sourceRanges can be set at the same time as
# sourceServiceAccounts. If both are set, the firewall applies to traffic that
# has a source IP address within the sourceRanges OR a source IP that belongs to
# an instance with service account listed in sourceServiceAccount. The
# connection does not need to match both fields for the firewall to apply.
# sourceServiceAccounts cannot be used at the same time as sourceTags or
# targetTags.
# Corresponds to the JSON property `sourceServiceAccounts`
# @return [Array<String>]
attr_accessor :source_service_accounts
# If source tags are specified, the firewall rule applies only to traffic with
# source IPs that match the primary network interfaces of VM instances that have
# the tag and are in the same VPC network. Source tags cannot be used to control
# traffic to an instance's external IP address, it only applies to traffic
# between instances in the same virtual network. Because tags are associated
# with instances, not IP addresses. One or both of sourceRanges and sourceTags
# may be set. If both fields are set, the firewall applies to traffic that has a
# source IP address within sourceRanges OR a source IP from a resource with a
# matching tag listed in the sourceTags field. The connection does not need to
# match both fields for the firewall to apply.
# Corresponds to the JSON property `sourceTags`
# @return [Array<String>]
attr_accessor :source_tags
# A list of service accounts indicating sets of instances located in the network
# that may make network connections as specified in allowed[].
# targetServiceAccounts cannot be used at the same time as targetTags or
# sourceTags. If neither targetServiceAccounts nor targetTags are specified, the
# firewall rule applies to all instances on the specified network.
# Corresponds to the JSON property `targetServiceAccounts`
# @return [Array<String>]
attr_accessor :target_service_accounts
# A list of tags that controls which instances the firewall rule applies to. If
# targetTags are specified, then the firewall rule applies only to instances in
# the VPC network that have one of those tags. If no targetTags are specified,
# the firewall rule applies to all instances on the specified network.
# Corresponds to the JSON property `targetTags`
# @return [Array<String>]
attr_accessor :target_tags
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@allowed = args[:allowed] if args.key?(:allowed)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@denied = args[:denied] if args.key?(:denied)
@description = args[:description] if args.key?(:description)
@destination_ranges = args[:destination_ranges] if args.key?(:destination_ranges)
@direction = args[:direction] if args.key?(:direction)
@disabled = args[:disabled] if args.key?(:disabled)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@log_config = args[:log_config] if args.key?(:log_config)
@name = args[:name] if args.key?(:name)
@network = args[:network] if args.key?(:network)
@priority = args[:priority] if args.key?(:priority)
@self_link = args[:self_link] if args.key?(:self_link)
@source_ranges = args[:source_ranges] if args.key?(:source_ranges)
@source_service_accounts = args[:source_service_accounts] if args.key?(:source_service_accounts)
@source_tags = args[:source_tags] if args.key?(:source_tags)
@target_service_accounts = args[:target_service_accounts] if args.key?(:target_service_accounts)
@target_tags = args[:target_tags] if args.key?(:target_tags)
end
#
class Allowed
include Google::Apis::Core::Hashable
# 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.
# Corresponds to the JSON property `IPProtocol`
# @return [String]
attr_accessor :ip_protocol
# An optional list of ports to which this rule applies. This field is only
# applicable for the 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"].
# Corresponds to the JSON property `ports`
# @return [Array<String>]
attr_accessor :ports
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@ip_protocol = args[:ip_protocol] if args.key?(:ip_protocol)
@ports = args[:ports] if args.key?(:ports)
end
end
#
class Denied
include Google::Apis::Core::Hashable
# 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.
# Corresponds to the JSON property `IPProtocol`
# @return [String]
attr_accessor :ip_protocol
# An optional list of ports to which this rule applies. This field is only
# applicable for the 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"].
# Corresponds to the JSON property `ports`
# @return [Array<String>]
attr_accessor :ports
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@ip_protocol = args[:ip_protocol] if args.key?(:ip_protocol)
@ports = args[:ports] if args.key?(:ports)
end
end
end
# Contains a list of firewalls.
class FirewallList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of Firewall resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::Firewall>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#firewallList for lists of
# firewalls.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::FirewallList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::FirewallList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# The available logging options for a firewall rule.
class FirewallLogConfig
include Google::Apis::Core::Hashable
# This field denotes whether to enable logging for a particular firewall rule.
# Corresponds to the JSON property `enable`
# @return [Boolean]
attr_accessor :enable
alias_method :enable?, :enable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@enable = args[:enable] if args.key?(:enable)
end
end
# Encapsulates numeric value that can be either absolute or relative.
class FixedOrPercent
include Google::Apis::Core::Hashable
# [Output Only] Absolute value of VM instances calculated based on the specific
# mode.
#
# - If the value is fixed, then the calculated value is equal to the fixed value.
#
# - If the value is a percent, then the calculated value is percent/100 *
# targetSize. For example, the calculated value of a 80% of a managed instance
# group with 150 instances would be (80/100 * 150) = 120 VM instances. If there
# is a remainder, the number is rounded up.
# Corresponds to the JSON property `calculated`
# @return [Fixnum]
attr_accessor :calculated
# Specifies a fixed number of VM instances. This must be a positive integer.
# Corresponds to the JSON property `fixed`
# @return [Fixnum]
attr_accessor :fixed
# Specifies a percentage of instances between 0 to 100%, inclusive. For example,
# specify 80 for 80%.
# Corresponds to the JSON property `percent`
# @return [Fixnum]
attr_accessor :percent
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@calculated = args[:calculated] if args.key?(:calculated)
@fixed = args[:fixed] if args.key?(:fixed)
@percent = args[:percent] if args.key?(:percent)
end
end
# Represents a Forwarding Rule resource.
# Forwarding rule resources in GCP can be either regional or global in scope:
# * [Global](/compute/docs/reference/rest/`$api_version`/globalForwardingRules) *
# [Regional](/compute/docs/reference/rest/`$api_version`/forwardingRules)
# A forwarding rule and its corresponding IP address represent the frontend
# configuration of a Google Cloud Platform load balancer. Forwarding rules can
# also reference target instances and Cloud VPN Classic gateways (
# targetVpnGateway).
# For more information, read Forwarding rule concepts and Using protocol
# forwarding.
# (== resource_for `$api_version`.forwardingRules ==) (== resource_for `$
# api_version`.globalForwardingRules ==) (== resource_for `$api_version`.
# regionForwardingRules ==)
class ForwardingRule
include Google::Apis::Core::Hashable
# IP address that this forwarding rule serves. When a client sends traffic to
# this IP address, the forwarding rule directs the traffic to the target that
# you specify in the forwarding rule.
# If you don't specify a reserved IP address, an ephemeral IP address is
# assigned. Methods for specifying an IP address:
# * IPv4 dotted decimal, as in `100.1.2.3` * Full URL, as in https://www.
# googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-
# name * Partial URL or by name, as in: * projects/project_id/regions/region/
# addresses/address-name * regions/region/addresses/address-name * global/
# addresses/address-name * address-name
# The loadBalancingScheme and the forwarding rule's target determine the type of
# IP address that you can use. For detailed information, refer to [IP address
# specifications](/load-balancing/docs/forwarding-rule-concepts#
# ip_address_specifications).
# Corresponds to the JSON property `IPAddress`
# @return [String]
attr_accessor :ip_address
# The IP protocol to which this rule applies. For protocol forwarding, valid
# options are TCP, UDP, ESP, AH, SCTP or ICMP.
# For Internal TCP/UDP Load Balancing, the load balancing scheme is INTERNAL,
# and one of TCP or UDP are valid. For Traffic Director, the load balancing
# scheme is INTERNAL_SELF_MANAGED, and only TCPis valid. For Internal HTTP(S)
# Load Balancing, the load balancing scheme is INTERNAL_MANAGED, and only TCP is
# valid. For HTTP(S), SSL Proxy, and TCP Proxy Load Balancing, the load
# balancing scheme is EXTERNAL and only TCP is valid. For Network TCP/UDP Load
# Balancing, the load balancing scheme is EXTERNAL, and one of TCP or UDP is
# valid.
# Corresponds to the JSON property `IPProtocol`
# @return [String]
attr_accessor :ip_protocol
# This field is used along with the backend_service field for internal load
# balancing or with the target field for internal TargetInstance. This field
# cannot be used with port or portRange fields.
# When the load balancing scheme is INTERNAL and protocol is TCP/UDP, specify
# this field to allow packets addressed to any ports will be forwarded to the
# backends configured with this forwarding rule.
# Corresponds to the JSON property `allPorts`
# @return [Boolean]
attr_accessor :all_ports
alias_method :all_ports?, :all_ports
# This field is used along with the backend_service field for internal load
# balancing or with the target field for internal TargetInstance. If the field
# is set to TRUE, clients can access ILB from all regions. Otherwise only allows
# access from clients in the same region as the internal load balancer.
# Corresponds to the JSON property `allowGlobalAccess`
# @return [Boolean]
attr_accessor :allow_global_access
alias_method :allow_global_access?, :allow_global_access
# This field is only used for INTERNAL load balancing.
# For internal load balancing, this field identifies the BackendService resource
# to receive the matched traffic.
# Corresponds to the JSON property `backendService`
# @return [String]
attr_accessor :backend_service
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :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.
# Corresponds to the JSON property `fingerprint`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :fingerprint
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# The IP Version that will be used by this forwarding rule. Valid options are
# IPV4 or IPV6. This can only be specified for an external global forwarding
# rule.
# Corresponds to the JSON property `ipVersion`
# @return [String]
attr_accessor :ip_version
# 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.
# Corresponds to the JSON property `isMirroringCollector`
# @return [Boolean]
attr_accessor :is_mirroring_collector
alias_method :is_mirroring_collector?, :is_mirroring_collector
# [Output Only] Type of the resource. Always compute#forwardingRule for
# Forwarding Rule resources.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Specifies the forwarding rule type.
#
# - EXTERNAL is used for:
# - Classic Cloud VPN gateways
# - Protocol forwarding to VMs from an external IP address
# - The following load balancers: HTTP(S), SSL Proxy, TCP Proxy, and Network TCP/
# UDP
# - INTERNAL is used for:
# - Protocol forwarding to VMs from an internal IP address
# - Internal TCP/UDP load balancers
# - INTERNAL_MANAGED is used for:
# - Internal HTTP(S) load balancers
# - INTERNAL_SELF_MANAGED is used for:
# - Traffic Director
# For more information about forwarding rules, refer to Forwarding rule concepts.
# Corresponds to the JSON property `loadBalancingScheme`
# @return [String]
attr_accessor :load_balancing_scheme
# Opaque filter criteria used by Loadbalancer to restrict routing configuration
# to a limited set of xDS compliant clients. In their xDS requests to
# Loadbalancer, xDS clients present node metadata. If a match takes place, the
# relevant configuration is made available to those proxies. Otherwise, all the
# resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule will
# not be 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.
# 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.
# Corresponds to the JSON property `metadataFilters`
# @return [Array<Google::Apis::ComputeV1::MetadataFilter>]
attr_accessor :metadata_filters
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# This field is not used for external load balancing.
# For INTERNAL and INTERNAL_SELF_MANAGED load balancing, this field identifies
# the network that the load balanced IP should belong to for this Forwarding
# Rule. If this field is not specified, the default network will be used.
# Corresponds to the JSON property `network`
# @return [String]
attr_accessor :network
# 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.
# Corresponds to the JSON property `networkTier`
# @return [String]
attr_accessor :network_tier
# When the load balancing scheme is EXTERNAL, INTERNAL_SELF_MANAGED and
# INTERNAL_MANAGED, you can specify a port_range. Use with a forwarding rule
# that points to a target proxy or a target pool. Do not use with a forwarding
# rule that points to a backend service. This field is used along with the
# target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy,
# TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance.
# Applicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed
# to ports in the specified range will be forwarded to target. Forwarding rules
# with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.
# Some types of forwarding target have constraints on the acceptable ports:
# - TargetHttpProxy: 80, 8080
# - TargetHttpsProxy: 443
# - TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688,
# 1883, 5222
# - TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688,
# 1883, 5222
# - TargetVpnGateway: 500, 4500
# Corresponds to the JSON property `portRange`
# @return [String]
attr_accessor :port_range
# This field is used along with the backend_service field for internal load
# balancing.
# When the load balancing scheme is INTERNAL, a list of ports can be configured,
# for example, ['80'], ['8000','9000']. Only packets addressed to these ports
# are forwarded to the backends configured with the forwarding rule.
# If the forwarding rule's loadBalancingScheme is INTERNAL, you can specify
# ports in one of the following ways:
# * A list of up to five ports, which can be non-contiguous * Keyword ALL, which
# causes the forwarding rule to forward traffic on any port of the forwarding
# rule's protocol.
# Corresponds to the JSON property `ports`
# @return [Array<String>]
attr_accessor :ports
# [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.
# Corresponds to the JSON property `region`
# @return [String]
attr_accessor :region
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# 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.
# Corresponds to the JSON property `serviceLabel`
# @return [String]
attr_accessor :service_label
# [Output Only] The internal fully qualified service name for this Forwarding
# Rule.
# This field is only used for internal load balancing.
# Corresponds to the JSON property `serviceName`
# @return [String]
attr_accessor :service_name
# This field is only used for INTERNAL load balancing.
# For internal load balancing, this field identifies the subnetwork that the
# load balanced IP should belong to for this Forwarding Rule.
# If the network specified is in auto subnet mode, this field is optional.
# However, if the network is in custom subnet mode, a subnetwork must be
# specified.
# Corresponds to the JSON property `subnetwork`
# @return [String]
attr_accessor :subnetwork
# The URL of the target resource to receive the matched traffic. For regional
# forwarding rules, this target must live 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 INTERNAL_SELF_MANAGED load balancing, only targetHttpProxy is
# valid, not targetHttpsProxy.
# Corresponds to the JSON property `target`
# @return [String]
attr_accessor :target
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@ip_address = args[:ip_address] if args.key?(:ip_address)
@ip_protocol = args[:ip_protocol] if args.key?(:ip_protocol)
@all_ports = args[:all_ports] if args.key?(:all_ports)
@allow_global_access = args[:allow_global_access] if args.key?(:allow_global_access)
@backend_service = args[:backend_service] if args.key?(:backend_service)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@fingerprint = args[:fingerprint] if args.key?(:fingerprint)
@id = args[:id] if args.key?(:id)
@ip_version = args[:ip_version] if args.key?(:ip_version)
@is_mirroring_collector = args[:is_mirroring_collector] if args.key?(:is_mirroring_collector)
@kind = args[:kind] if args.key?(:kind)
@load_balancing_scheme = args[:load_balancing_scheme] if args.key?(:load_balancing_scheme)
@metadata_filters = args[:metadata_filters] if args.key?(:metadata_filters)
@name = args[:name] if args.key?(:name)
@network = args[:network] if args.key?(:network)
@network_tier = args[:network_tier] if args.key?(:network_tier)
@port_range = args[:port_range] if args.key?(:port_range)
@ports = args[:ports] if args.key?(:ports)
@region = args[:region] if args.key?(:region)
@self_link = args[:self_link] if args.key?(:self_link)
@service_label = args[:service_label] if args.key?(:service_label)
@service_name = args[:service_name] if args.key?(:service_name)
@subnetwork = args[:subnetwork] if args.key?(:subnetwork)
@target = args[:target] if args.key?(:target)
end
end
#
class ForwardingRuleAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of ForwardingRulesScopedList resources.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::ForwardingRulesScopedList>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#forwardingRuleAggregatedList
# for lists of forwarding rules.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::ForwardingRuleAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::ForwardingRuleAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Contains a list of ForwardingRule resources.
class ForwardingRuleList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of ForwardingRule resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::ForwardingRule>]
attr_accessor :items
# Type of resource.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::ForwardingRuleList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::ForwardingRuleList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class ForwardingRuleReference
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `forwardingRule`
# @return [String]
attr_accessor :forwarding_rule
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@forwarding_rule = args[:forwarding_rule] if args.key?(:forwarding_rule)
end
end
#
class ForwardingRulesScopedList
include Google::Apis::Core::Hashable
# A list of forwarding rules contained in this scope.
# Corresponds to the JSON property `forwardingRules`
# @return [Array<Google::Apis::ComputeV1::ForwardingRule>]
attr_accessor :forwarding_rules
# Informational warning which replaces the list of forwarding rules when the
# list is empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::ForwardingRulesScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@forwarding_rules = args[:forwarding_rules] if args.key?(:forwarding_rules)
@warning = args[:warning] if args.key?(:warning)
end
# Informational warning which replaces the list of forwarding rules when the
# list is empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::ForwardingRulesScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class GrpcHealthCheck
include Google::Apis::Core::Hashable
# The gRPC service name for the health check. This field is optional. The value
# of grpc_service_name has the following meanings by convention:
# - Empty service_name means the overall status of all services at the backend.
# - Non-empty service_name means the health of that gRPC service, as defined by
# the owner of the service.
# The grpc_service_name can only be ASCII.
# Corresponds to the JSON property `grpcServiceName`
# @return [String]
attr_accessor :grpc_service_name
# The port number for the health check request. Must be specified if port_name
# and port_specification are not set or if port_specification is USE_FIXED_PORT.
# Valid values are 1 through 65535.
# Corresponds to the JSON property `port`
# @return [Fixnum]
attr_accessor :port
# Port name as defined in InstanceGroup#NamedPort#name. If both port and
# port_name are defined, port takes precedence. The port_name should conform to
# RFC1035.
# Corresponds to the JSON property `portName`
# @return [String]
attr_accessor :port_name
# Specifies how port is selected for health checking, can be one of following
# values:
# USE_FIXED_PORT: The port number in port is used for health checking.
# USE_NAMED_PORT: The portName is used for health checking.
# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each
# network endpoint is used for health checking. For other backends, the port or
# named port specified in the Backend Service is used for health checking.
# If not specified, gRPC health check follows behavior specified in port and
# portName fields.
# Corresponds to the JSON property `portSpecification`
# @return [String]
attr_accessor :port_specification
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@grpc_service_name = args[:grpc_service_name] if args.key?(:grpc_service_name)
@port = args[:port] if args.key?(:port)
@port_name = args[:port_name] if args.key?(:port_name)
@port_specification = args[:port_specification] if args.key?(:port_specification)
end
end
#
class GlobalNetworkEndpointGroupsAttachEndpointsRequest
include Google::Apis::Core::Hashable
# The list of network endpoints to be attached.
# Corresponds to the JSON property `networkEndpoints`
# @return [Array<Google::Apis::ComputeV1::NetworkEndpoint>]
attr_accessor :network_endpoints
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@network_endpoints = args[:network_endpoints] if args.key?(:network_endpoints)
end
end
#
class GlobalNetworkEndpointGroupsDetachEndpointsRequest
include Google::Apis::Core::Hashable
# The list of network endpoints to be detached.
# Corresponds to the JSON property `networkEndpoints`
# @return [Array<Google::Apis::ComputeV1::NetworkEndpoint>]
attr_accessor :network_endpoints
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@network_endpoints = args[:network_endpoints] if args.key?(:network_endpoints)
end
end
#
class GlobalSetLabelsRequest
include Google::Apis::Core::Hashable
# The fingerprint of the previous set of labels for this resource, used to
# detect conflicts. 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 when updating or changing labels,
# otherwise the request will fail with error 412 conditionNotMet. Make a get()
# request to the resource to get the latest fingerprint.
# Corresponds to the JSON property `labelFingerprint`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :label_fingerprint
# A list of labels to apply for this resource. Each label key & value must
# 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 example, "webserver-frontend": "images". A label value can also
# be empty (e.g. "my-label": "").
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint)
@labels = args[:labels] if args.key?(:labels)
end
end
#
class GlobalSetPolicyRequest
include Google::Apis::Core::Hashable
# Flatten Policy to create a backward compatible wire-format. Deprecated. Use '
# policy' to specify bindings.
# Corresponds to the JSON property `bindings`
# @return [Array<Google::Apis::ComputeV1::Binding>]
attr_accessor :bindings
# Flatten Policy to create a backward compatible wire-format. Deprecated. Use '
# policy' to specify the etag.
# Corresponds to the JSON property `etag`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :etag
# An Identity and Access Management (IAM) policy, which specifies access
# controls for Google Cloud resources.
# A `Policy` is a collection of `bindings`. A `binding` binds one or more `
# members` to a single `role`. Members can be user accounts, service accounts,
# Google groups, and domains (such as G Suite). A `role` is a named list of
# permissions; each `role` can be an IAM predefined role or a user-created
# custom role.
# For some types of Google Cloud resources, a `binding` can also specify a `
# condition`, which is a logical expression that allows access to a resource
# only if the expression evaluates to `true`. A condition can add constraints
# based on attributes of the request, the resource, or both. To learn which
# resources support conditions in their IAM policies, see the [IAM documentation]
# (https://cloud.google.com/iam/help/conditions/resource-policies).
# **JSON example:**
# ` "bindings": [ ` "role": "roles/resourcemanager.organizationAdmin", "members":
# [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "
# serviceAccount:my-project-id@appspot.gserviceaccount.com" ] `, ` "role": "
# roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com"
# ], "condition": ` "title": "expirable access", "description": "Does not grant
# access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:
# 00:00.000Z')", ` ` ], "etag": "BwWWja0YfJA=", "version": 3 `
# **YAML example:**
# bindings: - members: - user:mike@example.com - group:admins@example.com -
# domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com
# role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.
# com role: roles/resourcemanager.organizationViewer condition: title: expirable
# access description: Does not grant access after Sep 2020 expression: request.
# time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3
# For a description of IAM and its features, see the [IAM documentation](https://
# cloud.google.com/iam/docs/).
# Corresponds to the JSON property `policy`
# @return [Google::Apis::ComputeV1::Policy]
attr_accessor :policy
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@bindings = args[:bindings] if args.key?(:bindings)
@etag = args[:etag] if args.key?(:etag)
@policy = args[:policy] if args.key?(:policy)
end
end
# A guest attributes entry.
class GuestAttributes
include Google::Apis::Core::Hashable
# [Output Only] Type of the resource. Always compute#guestAttributes for guest
# attributes entry.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# The path to be queried. This can be the default namespace ('/') or a nested
# namespace ('/\/') or a specified key ('/\/\')
# Corresponds to the JSON property `queryPath`
# @return [String]
attr_accessor :query_path
# Array of guest attribute namespace/key/value tuples.
# Corresponds to the JSON property `queryValue`
# @return [Google::Apis::ComputeV1::GuestAttributesValue]
attr_accessor :query_value
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# The key to search for.
# Corresponds to the JSON property `variableKey`
# @return [String]
attr_accessor :variable_key
# [Output Only] The value found for the requested key.
# Corresponds to the JSON property `variableValue`
# @return [String]
attr_accessor :variable_value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@kind = args[:kind] if args.key?(:kind)
@query_path = args[:query_path] if args.key?(:query_path)
@query_value = args[:query_value] if args.key?(:query_value)
@self_link = args[:self_link] if args.key?(:self_link)
@variable_key = args[:variable_key] if args.key?(:variable_key)
@variable_value = args[:variable_value] if args.key?(:variable_value)
end
end
# A guest attributes namespace/key/value entry.
class GuestAttributesEntry
include Google::Apis::Core::Hashable
# Key for the guest attribute entry.
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# Namespace for the guest attribute entry.
# Corresponds to the JSON property `namespace`
# @return [String]
attr_accessor :namespace
# Value for the guest attribute entry.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@namespace = args[:namespace] if args.key?(:namespace)
@value = args[:value] if args.key?(:value)
end
end
# Array of guest attribute namespace/key/value tuples.
class GuestAttributesValue
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::GuestAttributesEntry>]
attr_accessor :items
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@items = args[:items] if args.key?(:items)
end
end
# Guest OS features.
class GuestOsFeature
include Google::Apis::Core::Hashable
# The ID of a supported feature. Read Enabling guest operating system features
# to see a list of available options.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@type = args[:type] if args.key?(:type)
end
end
#
class Http2HealthCheck
include Google::Apis::Core::Hashable
# The value of the host header in the HTTP/2 health check request. If left empty
# (default value), the IP on behalf of which this health check is performed will
# be used.
# Corresponds to the JSON property `host`
# @return [String]
attr_accessor :host
# The TCP port number for the health check request. The default value is 443.
# Valid values are 1 through 65535.
# Corresponds to the JSON property `port`
# @return [Fixnum]
attr_accessor :port
# Port name as defined in InstanceGroup#NamedPort#name. If both port and
# port_name are defined, port takes precedence.
# Corresponds to the JSON property `portName`
# @return [String]
attr_accessor :port_name
# Specifies how port is selected for health checking, can be one of following
# values:
# USE_FIXED_PORT: The port number in port is used for health checking.
# USE_NAMED_PORT: The portName is used for health checking.
# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each
# network endpoint is used for health checking. For other backends, the port or
# named port specified in the Backend Service is used for health checking.
# If not specified, HTTP2 health check follows behavior specified in port and
# portName fields.
# Corresponds to the JSON property `portSpecification`
# @return [String]
attr_accessor :port_specification
# Specifies the type of proxy header to append before sending data to the
# backend, either NONE or PROXY_V1. The default is NONE.
# Corresponds to the JSON property `proxyHeader`
# @return [String]
attr_accessor :proxy_header
# The request path of the HTTP/2 health check request. The default value is /.
# Corresponds to the JSON property `requestPath`
# @return [String]
attr_accessor :request_path
# The string to match anywhere in the first 1024 bytes of the response body. If
# left empty (the default value), the status code determines health. The
# response data can only be ASCII.
# Corresponds to the JSON property `response`
# @return [String]
attr_accessor :response
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@host = args[:host] if args.key?(:host)
@port = args[:port] if args.key?(:port)
@port_name = args[:port_name] if args.key?(:port_name)
@port_specification = args[:port_specification] if args.key?(:port_specification)
@proxy_header = args[:proxy_header] if args.key?(:proxy_header)
@request_path = args[:request_path] if args.key?(:request_path)
@response = args[:response] if args.key?(:response)
end
end
#
class HttpHealthCheck
include Google::Apis::Core::Hashable
# The value of the host header in the HTTP health check request. If left empty (
# default value), the IP on behalf of which this health check is performed will
# be used.
# Corresponds to the JSON property `host`
# @return [String]
attr_accessor :host
# The TCP port number for the health check request. The default value is 80.
# Valid values are 1 through 65535.
# Corresponds to the JSON property `port`
# @return [Fixnum]
attr_accessor :port
# Port name as defined in InstanceGroup#NamedPort#name. If both port and
# port_name are defined, port takes precedence.
# Corresponds to the JSON property `portName`
# @return [String]
attr_accessor :port_name
# Specifies how port is selected for health checking, can be one of following
# values:
# USE_FIXED_PORT: The port number in port is used for health checking.
# USE_NAMED_PORT: The portName is used for health checking.
# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each
# network endpoint is used for health checking. For other backends, the port or
# named port specified in the Backend Service is used for health checking.
# If not specified, HTTP health check follows behavior specified in port and
# portName fields.
# Corresponds to the JSON property `portSpecification`
# @return [String]
attr_accessor :port_specification
# Specifies the type of proxy header to append before sending data to the
# backend, either NONE or PROXY_V1. The default is NONE.
# Corresponds to the JSON property `proxyHeader`
# @return [String]
attr_accessor :proxy_header
# The request path of the HTTP health check request. The default value is /.
# Corresponds to the JSON property `requestPath`
# @return [String]
attr_accessor :request_path
# The string to match anywhere in the first 1024 bytes of the response body. If
# left empty (the default value), the status code determines health. The
# response data can only be ASCII.
# Corresponds to the JSON property `response`
# @return [String]
attr_accessor :response
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@host = args[:host] if args.key?(:host)
@port = args[:port] if args.key?(:port)
@port_name = args[:port_name] if args.key?(:port_name)
@port_specification = args[:port_specification] if args.key?(:port_specification)
@proxy_header = args[:proxy_header] if args.key?(:proxy_header)
@request_path = args[:request_path] if args.key?(:request_path)
@response = args[:response] if args.key?(:response)
end
end
#
class HttpsHealthCheck
include Google::Apis::Core::Hashable
# The value of the host header in the HTTPS health check request. If left empty (
# default value), the IP on behalf of which this health check is performed will
# be used.
# Corresponds to the JSON property `host`
# @return [String]
attr_accessor :host
# The TCP port number for the health check request. The default value is 443.
# Valid values are 1 through 65535.
# Corresponds to the JSON property `port`
# @return [Fixnum]
attr_accessor :port
# Port name as defined in InstanceGroup#NamedPort#name. If both port and
# port_name are defined, port takes precedence.
# Corresponds to the JSON property `portName`
# @return [String]
attr_accessor :port_name
# Specifies how port is selected for health checking, can be one of following
# values:
# USE_FIXED_PORT: The port number in port is used for health checking.
# USE_NAMED_PORT: The portName is used for health checking.
# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each
# network endpoint is used for health checking. For other backends, the port or
# named port specified in the Backend Service is used for health checking.
# If not specified, HTTPS health check follows behavior specified in port and
# portName fields.
# Corresponds to the JSON property `portSpecification`
# @return [String]
attr_accessor :port_specification
# Specifies the type of proxy header to append before sending data to the
# backend, either NONE or PROXY_V1. The default is NONE.
# Corresponds to the JSON property `proxyHeader`
# @return [String]
attr_accessor :proxy_header
# The request path of the HTTPS health check request. The default value is /.
# Corresponds to the JSON property `requestPath`
# @return [String]
attr_accessor :request_path
# The string to match anywhere in the first 1024 bytes of the response body. If
# left empty (the default value), the status code determines health. The
# response data can only be ASCII.
# Corresponds to the JSON property `response`
# @return [String]
attr_accessor :response
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@host = args[:host] if args.key?(:host)
@port = args[:port] if args.key?(:port)
@port_name = args[:port_name] if args.key?(:port_name)
@port_specification = args[:port_specification] if args.key?(:port_specification)
@proxy_header = args[:proxy_header] if args.key?(:proxy_header)
@request_path = args[:request_path] if args.key?(:request_path)
@response = args[:response] if args.key?(:response)
end
end
# Represents a Health Check resource.
# Google Compute Engine has two Health Check resources:
# * [Global](/compute/docs/reference/rest/`$api_version`/healthChecks) * [
# Regional](/compute/docs/reference/rest/`$api_version`/regionHealthChecks)
# Internal HTTP(S) load balancers use regional health checks. All other types of
# GCP load balancers and managed instance group auto-healing use global health
# checks. For more information, read Health Check Concepts.
# To perform health checks on network load balancers, you must use either
# httpHealthChecks or httpsHealthChecks.
class HealthCheck
include Google::Apis::Core::Hashable
# How often (in seconds) to send a health check. The default value is 5 seconds.
# Corresponds to the JSON property `checkIntervalSec`
# @return [Fixnum]
attr_accessor :check_interval_sec
# [Output Only] Creation timestamp in 3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
#
# Corresponds to the JSON property `grpcHealthCheck`
# @return [Google::Apis::ComputeV1::GrpcHealthCheck]
attr_accessor :grpc_health_check
# A so-far unhealthy instance will be marked healthy after this many consecutive
# successes. The default value is 2.
# Corresponds to the JSON property `healthyThreshold`
# @return [Fixnum]
attr_accessor :healthy_threshold
#
# Corresponds to the JSON property `http2HealthCheck`
# @return [Google::Apis::ComputeV1::Http2HealthCheck]
attr_accessor :http2_health_check
#
# Corresponds to the JSON property `httpHealthCheck`
# @return [Google::Apis::ComputeV1::HttpHealthCheck]
attr_accessor :http_health_check
#
# Corresponds to the JSON property `httpsHealthCheck`
# @return [Google::Apis::ComputeV1::HttpsHealthCheck]
attr_accessor :https_health_check
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# Type of the resource.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Configuration of logging on a health check. If logging is enabled, logs will
# be exported to Stackdriver.
# Corresponds to the JSON property `logConfig`
# @return [Google::Apis::ComputeV1::HealthCheckLogConfig]
attr_accessor :log_config
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# [Output Only] Region where the health check resides. Not applicable to global
# health checks.
# Corresponds to the JSON property `region`
# @return [String]
attr_accessor :region
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
#
# Corresponds to the JSON property `sslHealthCheck`
# @return [Google::Apis::ComputeV1::SslHealthCheck]
attr_accessor :ssl_health_check
#
# Corresponds to the JSON property `tcpHealthCheck`
# @return [Google::Apis::ComputeV1::TcpHealthCheck]
attr_accessor :tcp_health_check
# How long (in seconds) to wait before claiming failure. The default value is 5
# seconds. It is invalid for timeoutSec to have greater value than
# checkIntervalSec.
# Corresponds to the JSON property `timeoutSec`
# @return [Fixnum]
attr_accessor :timeout_sec
# Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2.
# If not specified, the default is TCP. Exactly one of the protocol-specific
# health check field must be specified, which must match type field.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
# A so-far healthy instance will be marked unhealthy after this many consecutive
# failures. The default value is 2.
# Corresponds to the JSON property `unhealthyThreshold`
# @return [Fixnum]
attr_accessor :unhealthy_threshold
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@check_interval_sec = args[:check_interval_sec] if args.key?(:check_interval_sec)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@grpc_health_check = args[:grpc_health_check] if args.key?(:grpc_health_check)
@healthy_threshold = args[:healthy_threshold] if args.key?(:healthy_threshold)
@http2_health_check = args[:http2_health_check] if args.key?(:http2_health_check)
@http_health_check = args[:http_health_check] if args.key?(:http_health_check)
@https_health_check = args[:https_health_check] if args.key?(:https_health_check)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@log_config = args[:log_config] if args.key?(:log_config)
@name = args[:name] if args.key?(:name)
@region = args[:region] if args.key?(:region)
@self_link = args[:self_link] if args.key?(:self_link)
@ssl_health_check = args[:ssl_health_check] if args.key?(:ssl_health_check)
@tcp_health_check = args[:tcp_health_check] if args.key?(:tcp_health_check)
@timeout_sec = args[:timeout_sec] if args.key?(:timeout_sec)
@type = args[:type] if args.key?(:type)
@unhealthy_threshold = args[:unhealthy_threshold] if args.key?(:unhealthy_threshold)
end
end
# Contains a list of HealthCheck resources.
class HealthCheckList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of HealthCheck resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::HealthCheck>]
attr_accessor :items
# Type of resource.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::HealthCheckList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::HealthCheckList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Configuration of logging on a health check. If logging is enabled, logs will
# be exported to Stackdriver.
class HealthCheckLogConfig
include Google::Apis::Core::Hashable
# Indicates whether or not to export logs. This is false by default, which means
# no health check logging will be done.
# Corresponds to the JSON property `enable`
# @return [Boolean]
attr_accessor :enable
alias_method :enable?, :enable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@enable = args[:enable] if args.key?(:enable)
end
end
# A full or valid partial URL to a health check. For example, the following are
# valid URLs:
# - https://www.googleapis.com/compute/beta/projects/project-id/global/
# httpHealthChecks/health-check
# - projects/project-id/global/httpHealthChecks/health-check
# - global/httpHealthChecks/health-check
class HealthCheckReference
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `healthCheck`
# @return [String]
attr_accessor :health_check
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@health_check = args[:health_check] if args.key?(:health_check)
end
end
# Represents a Health-Check as a Service resource.
# (== resource_for `$api_version`.regionHealthCheckServices ==)
class HealthCheckService
include Google::Apis::Core::Hashable
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :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 HealthCheckService. An up-to-date fingerprint must be provided in
# order to patch/update the HealthCheckService; Otherwise, the request will fail
# with error 412 conditionNotMet. To see the latest fingerprint, make a get()
# request to retrieve the HealthCheckService.
# Corresponds to the JSON property `fingerprint`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :fingerprint
# List of URLs to the HealthCheck resources. Must have at least one HealthCheck,
# and not more than 10. HealthCheck resources must have portSpecification=
# USE_SERVING_PORT. For regional HealthCheckService, the HealthCheck must be
# regional and in the same region. For global HealthCheckService, HealthCheck
# must be global. Mix of regional and global HealthChecks is not supported.
# Multiple regional HealthChecks must belong to the same region. Regional
# HealthChecks</code? must belong to the same region as zones of NEGs.
# Corresponds to the JSON property `healthChecks`
# @return [Array<String>]
attr_accessor :health_checks
# Optional. Policy for how the results from multiple health checks for the same
# endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified.
# - NO_AGGREGATION. An EndpointHealth message is returned for each backend in
# the health check service.
# - AND. If any backend's health check reports UNHEALTHY, then UNHEALTHY is the
# HealthState of the entire health check service. If all backend's are healthy,
# the HealthState of the health check service is HEALTHY. .
# Corresponds to the JSON property `healthStatusAggregationPolicy`
# @return [String]
attr_accessor :health_status_aggregation_policy
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output only] Type of the resource. Always compute#healthCheckServicefor
# health check services.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Name of the resource. 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# List of URLs to the NetworkEndpointGroup resources. Must not have more than
# 100. For regional HealthCheckService, NEGs must be in zones in the region of
# the HealthCheckService.
# Corresponds to the JSON property `networkEndpointGroups`
# @return [Array<String>]
attr_accessor :network_endpoint_groups
# List of URLs to the NotificationEndpoint resources. Must not have more than 10.
# A list of endpoints for receiving notifications of change in health status.
# For regional HealthCheckService, NotificationEndpoint must be regional and in
# the same region. For global HealthCheckService, NotificationEndpoint must be
# global.
# Corresponds to the JSON property `notificationEndpoints`
# @return [Array<String>]
attr_accessor :notification_endpoints
# [Output Only] URL of the region where the health check service resides. This
# field is not applicable to global health check services. You must specify this
# field as part of the HTTP request URL. It is not settable as a field in the
# request body.
# Corresponds to the JSON property `region`
# @return [String]
attr_accessor :region
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@fingerprint = args[:fingerprint] if args.key?(:fingerprint)
@health_checks = args[:health_checks] if args.key?(:health_checks)
@health_status_aggregation_policy = args[:health_status_aggregation_policy] if args.key?(:health_status_aggregation_policy)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@network_endpoint_groups = args[:network_endpoint_groups] if args.key?(:network_endpoint_groups)
@notification_endpoints = args[:notification_endpoints] if args.key?(:notification_endpoints)
@region = args[:region] if args.key?(:region)
@self_link = args[:self_link] if args.key?(:self_link)
end
end
# A full or valid partial URL to a health check service. For example, the
# following are valid URLs:
# - https://www.googleapis.com/compute/beta/projects/project-id/regions/us-west1/
# healthCheckServices/health-check-service
# - projects/project-id/regions/us-west1/healthCheckServices/health-check-
# service
# - regions/us-west1/healthCheckServices/health-check-service
class HealthCheckServiceReference
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `healthCheckService`
# @return [String]
attr_accessor :health_check_service
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@health_check_service = args[:health_check_service] if args.key?(:health_check_service)
end
end
#
class HealthCheckServicesList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of HealthCheckService resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::HealthCheckService>]
attr_accessor :items
# [Output Only] Type of the resource. Always compute#healthCheckServicesList for
# lists of HealthCheckServices.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::HealthCheckServicesList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::HealthCheckServicesList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class HealthChecksAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of HealthChecksScopedList resources.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::HealthChecksScopedList>]
attr_accessor :items
# Type of resource.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::HealthChecksAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::HealthChecksAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class HealthChecksScopedList
include Google::Apis::Core::Hashable
# A list of HealthChecks contained in this scope.
# Corresponds to the JSON property `healthChecks`
# @return [Array<Google::Apis::ComputeV1::HealthCheck>]
attr_accessor :health_checks
# Informational warning which replaces the list of backend services when the
# list is empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::HealthChecksScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@health_checks = args[:health_checks] if args.key?(:health_checks)
@warning = args[:warning] if args.key?(:warning)
end
# Informational warning which replaces the list of backend services when the
# list is empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::HealthChecksScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class HealthStatus
include Google::Apis::Core::Hashable
# Metadata defined as annotations for network endpoint.
# Corresponds to the JSON property `annotations`
# @return [Hash<String,String>]
attr_accessor :annotations
# Health state of the instance.
# Corresponds to the JSON property `healthState`
# @return [String]
attr_accessor :health_state
# URL of the instance resource.
# Corresponds to the JSON property `instance`
# @return [String]
attr_accessor :instance
# A forwarding rule IP address assigned to this instance.
# Corresponds to the JSON property `ipAddress`
# @return [String]
attr_accessor :ip_address
# The named port of the instance group, not necessarily the port that is health-
# checked.
# Corresponds to the JSON property `port`
# @return [Fixnum]
attr_accessor :port
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@annotations = args[:annotations] if args.key?(:annotations)
@health_state = args[:health_state] if args.key?(:health_state)
@instance = args[:instance] if args.key?(:instance)
@ip_address = args[:ip_address] if args.key?(:ip_address)
@port = args[:port] if args.key?(:port)
end
end
#
class HealthStatusForNetworkEndpoint
include Google::Apis::Core::Hashable
# URL of the backend service associated with the health state of the network
# endpoint.
# Corresponds to the JSON property `backendService`
# @return [Google::Apis::ComputeV1::BackendServiceReference]
attr_accessor :backend_service
# URL of the forwarding rule associated with the health state of the network
# endpoint.
# Corresponds to the JSON property `forwardingRule`
# @return [Google::Apis::ComputeV1::ForwardingRuleReference]
attr_accessor :forwarding_rule
# A full or valid partial URL to a health check. For example, the following are
# valid URLs:
# - https://www.googleapis.com/compute/beta/projects/project-id/global/
# httpHealthChecks/health-check
# - projects/project-id/global/httpHealthChecks/health-check
# - global/httpHealthChecks/health-check
# Corresponds to the JSON property `healthCheck`
# @return [Google::Apis::ComputeV1::HealthCheckReference]
attr_accessor :health_check
# A full or valid partial URL to a health check service. For example, the
# following are valid URLs:
# - https://www.googleapis.com/compute/beta/projects/project-id/regions/us-west1/
# healthCheckServices/health-check-service
# - projects/project-id/regions/us-west1/healthCheckServices/health-check-
# service
# - regions/us-west1/healthCheckServices/health-check-service
# Corresponds to the JSON property `healthCheckService`
# @return [Google::Apis::ComputeV1::HealthCheckServiceReference]
attr_accessor :health_check_service
# Health state of the network endpoint determined based on the health checks
# configured.
# Corresponds to the JSON property `healthState`
# @return [String]
attr_accessor :health_state
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@backend_service = args[:backend_service] if args.key?(:backend_service)
@forwarding_rule = args[:forwarding_rule] if args.key?(:forwarding_rule)
@health_check = args[:health_check] if args.key?(:health_check)
@health_check_service = args[:health_check_service] if args.key?(:health_check_service)
@health_state = args[:health_state] if args.key?(:health_state)
end
end
# UrlMaps A host-matching rule for a URL. If matched, will use the named
# PathMatcher to select the BackendService.
class HostRule
include Google::Apis::Core::Hashable
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :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 must be followed in the
# pattern by either - or ..
# Corresponds to the JSON property `hosts`
# @return [Array<String>]
attr_accessor :hosts
# The name of the PathMatcher to use to match the path portion of the URL if the
# hostRule matches the URL's host portion.
# Corresponds to the JSON property `pathMatcher`
# @return [String]
attr_accessor :path_matcher
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@description = args[:description] if args.key?(:description)
@hosts = args[:hosts] if args.key?(:hosts)
@path_matcher = args[:path_matcher] if args.key?(:path_matcher)
end
end
# Specification for how requests are aborted as part of fault injection.
class HttpFaultAbort
include Google::Apis::Core::Hashable
# The HTTP status code used to abort the request.
# The value must be between 200 and 599 inclusive.
# Corresponds to the JSON property `httpStatus`
# @return [Fixnum]
attr_accessor :http_status
# The percentage of traffic (connections/operations/requests) which will be
# aborted as part of fault injection.
# The value must be between 0.0 and 100.0 inclusive.
# Corresponds to the JSON property `percentage`
# @return [Float]
attr_accessor :percentage
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@http_status = args[:http_status] if args.key?(:http_status)
@percentage = args[:percentage] if args.key?(:percentage)
end
end
# Specifies the delay introduced by Loadbalancer before forwarding the request
# to the backend service as part of fault injection.
class HttpFaultDelay
include Google::Apis::Core::Hashable
# A Duration represents a fixed-length span of time represented as a count of
# seconds and fractions of seconds at nanosecond resolution. It is independent
# of any calendar and concepts like "day" or "month". Range is approximately 10,
# 000 years.
# Corresponds to the JSON property `fixedDelay`
# @return [Google::Apis::ComputeV1::Duration]
attr_accessor :fixed_delay
# The percentage of traffic (connections/operations/requests) on which delay
# will be introduced as part of fault injection.
# The value must be between 0.0 and 100.0 inclusive.
# Corresponds to the JSON property `percentage`
# @return [Float]
attr_accessor :percentage
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@fixed_delay = args[:fixed_delay] if args.key?(:fixed_delay)
@percentage = args[:percentage] if args.key?(:percentage)
end
end
# 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
# Loadbalancer on a percentage of requests before sending those request to the
# backend service. Similarly requests from clients can be aborted by the
# Loadbalancer for a percentage of requests.
class HttpFaultInjection
include Google::Apis::Core::Hashable
# Specification for how requests are aborted as part of fault injection.
# Corresponds to the JSON property `abort`
# @return [Google::Apis::ComputeV1::HttpFaultAbort]
attr_accessor :abort
# Specifies the delay introduced by Loadbalancer before forwarding the request
# to the backend service as part of fault injection.
# Corresponds to the JSON property `delay`
# @return [Google::Apis::ComputeV1::HttpFaultDelay]
attr_accessor :delay
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@abort = args[:abort] if args.key?(:abort)
@delay = args[:delay] if args.key?(:delay)
end
end
# The request and response header transformations that take effect before the
# request is passed along to the selected backendService.
class HttpHeaderAction
include Google::Apis::Core::Hashable
# Headers to add to a matching request prior to forwarding the request to the
# backendService.
# Corresponds to the JSON property `requestHeadersToAdd`
# @return [Array<Google::Apis::ComputeV1::HttpHeaderOption>]
attr_accessor :request_headers_to_add
# A list of header names for headers that need to be removed from the request
# prior to forwarding the request to the backendService.
# Corresponds to the JSON property `requestHeadersToRemove`
# @return [Array<String>]
attr_accessor :request_headers_to_remove
# Headers to add the response prior to sending the response back to the client.
# Corresponds to the JSON property `responseHeadersToAdd`
# @return [Array<Google::Apis::ComputeV1::HttpHeaderOption>]
attr_accessor :response_headers_to_add
# A list of header names for headers that need to be removed from the response
# prior to sending the response back to the client.
# Corresponds to the JSON property `responseHeadersToRemove`
# @return [Array<String>]
attr_accessor :response_headers_to_remove
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@request_headers_to_add = args[:request_headers_to_add] if args.key?(:request_headers_to_add)
@request_headers_to_remove = args[:request_headers_to_remove] if args.key?(:request_headers_to_remove)
@response_headers_to_add = args[:response_headers_to_add] if args.key?(:response_headers_to_add)
@response_headers_to_remove = args[:response_headers_to_remove] if args.key?(:response_headers_to_remove)
end
end
# matchRule criteria for request header matches.
class HttpHeaderMatch
include Google::Apis::Core::Hashable
# The value should exactly match contents of exactMatch.
# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or
# rangeMatch must be set.
# Corresponds to the JSON property `exactMatch`
# @return [String]
attr_accessor :exact_match
# 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".
# Corresponds to the JSON property `headerName`
# @return [String]
attr_accessor :header_name
# If set to false, the headerMatch is considered a match if the match criteria
# above are met. If set to true, the headerMatch is considered a match if the
# match criteria above are NOT met.
# The default setting is false.
# Corresponds to the JSON property `invertMatch`
# @return [Boolean]
attr_accessor :invert_match
alias_method :invert_match?, :invert_match
# 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.
# Corresponds to the JSON property `prefixMatch`
# @return [String]
attr_accessor :prefix_match
# 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.
# Corresponds to the JSON property `presentMatch`
# @return [Boolean]
attr_accessor :present_match
alias_method :present_match?, :present_match
# HttpRouteRuleMatch criteria for field values that must stay within the
# specified integer range.
# Corresponds to the JSON property `rangeMatch`
# @return [Google::Apis::ComputeV1::Int64RangeMatch]
attr_accessor :range_match
# The value of the header must match the regular expression specified in
# regexMatch. For regular expression grammar, please see: en.cppreference.com/w/
# cpp/regex/ecmascript
# 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.
# Note that regexMatch only applies to Loadbalancers that have their
# loadBalancingScheme set to INTERNAL_SELF_MANAGED.
# Corresponds to the JSON property `regexMatch`
# @return [String]
attr_accessor :regex_match
# 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.
# Corresponds to the JSON property `suffixMatch`
# @return [String]
attr_accessor :suffix_match
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@exact_match = args[:exact_match] if args.key?(:exact_match)
@header_name = args[:header_name] if args.key?(:header_name)
@invert_match = args[:invert_match] if args.key?(:invert_match)
@prefix_match = args[:prefix_match] if args.key?(:prefix_match)
@present_match = args[:present_match] if args.key?(:present_match)
@range_match = args[:range_match] if args.key?(:range_match)
@regex_match = args[:regex_match] if args.key?(:regex_match)
@suffix_match = args[:suffix_match] if args.key?(:suffix_match)
end
end
# Specification determining how headers are added to requests or responses.
class HttpHeaderOption
include Google::Apis::Core::Hashable
# The name of the header.
# Corresponds to the JSON property `headerName`
# @return [String]
attr_accessor :header_name
# The value of the header to add.
# Corresponds to the JSON property `headerValue`
# @return [String]
attr_accessor :header_value
# 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.
# Corresponds to the JSON property `replace`
# @return [Boolean]
attr_accessor :replace
alias_method :replace?, :replace
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@header_name = args[:header_name] if args.key?(:header_name)
@header_value = args[:header_value] if args.key?(:header_value)
@replace = args[:replace] if args.key?(:replace)
end
end
# Represents a legacy HTTP Health Check resource.
# Legacy health checks are required by network load balancers. For more
# information, read Health Check Concepts.
class HttpHealthCheck
include Google::Apis::Core::Hashable
# How often (in seconds) to send a health check. The default value is 5 seconds.
# Corresponds to the JSON property `checkIntervalSec`
# @return [Fixnum]
attr_accessor :check_interval_sec
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# A so-far unhealthy instance will be marked healthy after this many consecutive
# successes. The default value is 2.
# Corresponds to the JSON property `healthyThreshold`
# @return [Fixnum]
attr_accessor :healthy_threshold
# The value of the host header in the HTTP health check request. If left empty (
# default value), the public IP on behalf of which this health check is
# performed will be used.
# Corresponds to the JSON property `host`
# @return [String]
attr_accessor :host
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP
# health checks.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The TCP port number for the HTTP health check request. The default value is 80.
# Corresponds to the JSON property `port`
# @return [Fixnum]
attr_accessor :port
# The request path of the HTTP health check request. The default value is /.
# This field does not support query parameters.
# Corresponds to the JSON property `requestPath`
# @return [String]
attr_accessor :request_path
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# How long (in seconds) to wait before claiming failure. The default value is 5
# seconds. It is invalid for timeoutSec to have greater value than
# checkIntervalSec.
# Corresponds to the JSON property `timeoutSec`
# @return [Fixnum]
attr_accessor :timeout_sec
# A so-far healthy instance will be marked unhealthy after this many consecutive
# failures. The default value is 2.
# Corresponds to the JSON property `unhealthyThreshold`
# @return [Fixnum]
attr_accessor :unhealthy_threshold
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@check_interval_sec = args[:check_interval_sec] if args.key?(:check_interval_sec)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@healthy_threshold = args[:healthy_threshold] if args.key?(:healthy_threshold)
@host = args[:host] if args.key?(:host)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@port = args[:port] if args.key?(:port)
@request_path = args[:request_path] if args.key?(:request_path)
@self_link = args[:self_link] if args.key?(:self_link)
@timeout_sec = args[:timeout_sec] if args.key?(:timeout_sec)
@unhealthy_threshold = args[:unhealthy_threshold] if args.key?(:unhealthy_threshold)
end
end
# Contains a list of HttpHealthCheck resources.
class HttpHealthCheckList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of HttpHealthCheck resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::HttpHealthCheck>]
attr_accessor :items
# Type of resource.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::HttpHealthCheckList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::HttpHealthCheckList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# HttpRouteRuleMatch criteria for a request's query parameter.
class HttpQueryParameterMatch
include Google::Apis::Core::Hashable
# 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.
# Corresponds to the JSON property `exactMatch`
# @return [String]
attr_accessor :exact_match
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# 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.
# Corresponds to the JSON property `presentMatch`
# @return [Boolean]
attr_accessor :present_match
alias_method :present_match?, :present_match
# The queryParameterMatch matches if the value of the parameter matches the
# regular expression specified by regexMatch. For the regular expression grammar,
# please see en.cppreference.com/w/cpp/regex/ecmascript
# Only one of presentMatch, exactMatch or regexMatch must be set.
# Note that regexMatch only applies when the loadBalancingScheme is set to
# INTERNAL_SELF_MANAGED.
# Corresponds to the JSON property `regexMatch`
# @return [String]
attr_accessor :regex_match
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@exact_match = args[:exact_match] if args.key?(:exact_match)
@name = args[:name] if args.key?(:name)
@present_match = args[:present_match] if args.key?(:present_match)
@regex_match = args[:regex_match] if args.key?(:regex_match)
end
end
# Specifies settings for an HTTP redirect.
class HttpRedirectAction
include Google::Apis::Core::Hashable
# The host that will be used in the redirect response instead of the one that
# was supplied in the request.
# The value must be between 1 and 255 characters.
# Corresponds to the JSON property `hostRedirect`
# @return [String]
attr_accessor :host_redirect
# 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 will remain the same as
# that of the request.
# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true
# for TargetHttpsProxy is not permitted.
# The default is set to false.
# Corresponds to the JSON property `httpsRedirect`
# @return [Boolean]
attr_accessor :https_redirect
alias_method :https_redirect?, :https_redirect
# The path that will be 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 will be
# used for the redirect.
# The value must be between 1 and 1024 characters.
# Corresponds to the JSON property `pathRedirect`
# @return [String]
attr_accessor :path_redirect
# 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 will be
# used for the redirect.
# The value must be between 1 and 1024 characters.
# Corresponds to the JSON property `prefixRedirect`
# @return [String]
attr_accessor :prefix_redirect
# 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 will be retained.
# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request
# method will be retained.
# Corresponds to the JSON property `redirectResponseCode`
# @return [String]
attr_accessor :redirect_response_code
# If set to true, any accompanying query portion of the original URL is removed
# prior to redirecting the request. If set to false, the query portion of the
# original URL is retained.
# The default is set to false.
# Corresponds to the JSON property `stripQuery`
# @return [Boolean]
attr_accessor :strip_query
alias_method :strip_query?, :strip_query
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@host_redirect = args[:host_redirect] if args.key?(:host_redirect)
@https_redirect = args[:https_redirect] if args.key?(:https_redirect)
@path_redirect = args[:path_redirect] if args.key?(:path_redirect)
@prefix_redirect = args[:prefix_redirect] if args.key?(:prefix_redirect)
@redirect_response_code = args[:redirect_response_code] if args.key?(:redirect_response_code)
@strip_query = args[:strip_query] if args.key?(:strip_query)
end
end
# The retry policy associates with HttpRouteRule
class HttpRetryPolicy
include Google::Apis::Core::Hashable
# Specifies the allowed number retries. This number must be > 0. If not
# specified, defaults to 1.
# Corresponds to the JSON property `numRetries`
# @return [Fixnum]
attr_accessor :num_retries
# A Duration represents a fixed-length span of time represented as a count of
# seconds and fractions of seconds at nanosecond resolution. It is independent
# of any calendar and concepts like "day" or "month". Range is approximately 10,
# 000 years.
# Corresponds to the JSON property `perTryTimeout`
# @return [Google::Apis::ComputeV1::Duration]
attr_accessor :per_try_timeout
# Specfies one or more conditions when this retry rule applies. Valid values are:
#
# - 5xx: Loadbalancer will attempt a retry if the backend service responds with
# any 5xx response code, or if the backend service does not respond at all,
# 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: Loadbalancer will retry on failures connecting to backend
# services, for example due to connection timeouts.
# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes.
# Currently the only retriable error supported is 409.
# - refused-stream:Loadbalancer will retry if the backend service resets the
# stream with a REFUSED_STREAM error code. This reset type indicates that it is
# safe to retry.
# - cancelledLoadbalancer will retry if the gRPC status code in the response
# header is set to cancelled
# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the
# response header is set to deadline-exceeded
# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the
# response header is set to resource-exhausted
# - unavailable: Loadbalancer will retry if the gRPC status code in the response
# header is set to unavailable
# Corresponds to the JSON property `retryConditions`
# @return [Array<String>]
attr_accessor :retry_conditions
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@num_retries = args[:num_retries] if args.key?(:num_retries)
@per_try_timeout = args[:per_try_timeout] if args.key?(:per_try_timeout)
@retry_conditions = args[:retry_conditions] if args.key?(:retry_conditions)
end
end
#
class HttpRouteAction
include Google::Apis::Core::Hashable
# The specification for allowing client side cross-origin requests. Please see
# W3C Recommendation for Cross Origin Resource Sharing
# Corresponds to the JSON property `corsPolicy`
# @return [Google::Apis::ComputeV1::CorsPolicy]
attr_accessor :cors_policy
# 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
# Loadbalancer on a percentage of requests before sending those request to the
# backend service. Similarly requests from clients can be aborted by the
# Loadbalancer for a percentage of requests.
# Corresponds to the JSON property `faultInjectionPolicy`
# @return [Google::Apis::ComputeV1::HttpFaultInjection]
attr_accessor :fault_injection_policy
# A policy that specifies how requests intended for the route's backends are
# shadowed to a separate mirrored backend service. Loadbalancer does not wait
# for responses from the shadow service. Prior to sending traffic to the shadow
# service, the host / authority header is suffixed with -shadow.
# Corresponds to the JSON property `requestMirrorPolicy`
# @return [Google::Apis::ComputeV1::RequestMirrorPolicy]
attr_accessor :request_mirror_policy
# The retry policy associates with HttpRouteRule
# Corresponds to the JSON property `retryPolicy`
# @return [Google::Apis::ComputeV1::HttpRetryPolicy]
attr_accessor :retry_policy
# A Duration represents a fixed-length span of time represented as a count of
# seconds and fractions of seconds at nanosecond resolution. It is independent
# of any calendar and concepts like "day" or "month". Range is approximately 10,
# 000 years.
# Corresponds to the JSON property `timeout`
# @return [Google::Apis::ComputeV1::Duration]
attr_accessor :timeout
# The spec for modifying the path before sending the request to the matched
# backend service.
# Corresponds to the JSON property `urlRewrite`
# @return [Google::Apis::ComputeV1::UrlRewrite]
attr_accessor :url_rewrite
# 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 0
# number.
# Once a backendService is identified and before forwarding the request to the
# backend service, advanced routing actions like Url rewrites and header
# transformations are applied depending on additional settings specified in this
# HttpRouteAction.
# Corresponds to the JSON property `weightedBackendServices`
# @return [Array<Google::Apis::ComputeV1::WeightedBackendService>]
attr_accessor :weighted_backend_services
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@cors_policy = args[:cors_policy] if args.key?(:cors_policy)
@fault_injection_policy = args[:fault_injection_policy] if args.key?(:fault_injection_policy)
@request_mirror_policy = args[:request_mirror_policy] if args.key?(:request_mirror_policy)
@retry_policy = args[:retry_policy] if args.key?(:retry_policy)
@timeout = args[:timeout] if args.key?(:timeout)
@url_rewrite = args[:url_rewrite] if args.key?(:url_rewrite)
@weighted_backend_services = args[:weighted_backend_services] if args.key?(:weighted_backend_services)
end
end
# An HttpRouteRule specifies how to match an HTTP request and the corresponding
# routing action that load balancing proxies will perform.
class HttpRouteRule
include Google::Apis::Core::Hashable
# The short description conveying the intent of this routeRule.
# The description can have a maximum length of 1024 characters.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# The request and response header transformations that take effect before the
# request is passed along to the selected backendService.
# Corresponds to the JSON property `headerAction`
# @return [Google::Apis::ComputeV1::HttpHeaderAction]
attr_accessor :header_action
#
# Corresponds to the JSON property `matchRules`
# @return [Array<Google::Apis::ComputeV1::HttpRouteRuleMatch>]
attr_accessor :match_rules
# For routeRules within a given pathMatcher, priority determines the order in
# which load balancer will interpret 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 between 0 and 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.
# Corresponds to the JSON property `priority`
# @return [Fixnum]
attr_accessor :priority
# In response to a matching matchRule, the load balancer performs advanced
# routing actions like URL rewrites, header transformations, etc. prior to
# 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.
# Corresponds to the JSON property `routeAction`
# @return [Google::Apis::ComputeV1::HttpRouteAction]
attr_accessor :route_action
# The full or partial URL of the backend service resource to which traffic is
# directed if this rule is matched. If routeAction is additionally specified,
# advanced routing actions like URL Rewrites, etc. take effect prior to sending
# the request to the backend. However, if service is specified, routeAction
# cannot contain any weightedBackendService s. Conversely, if routeAction
# specifies any weightedBackendServices, service must not be specified.
# Only one of urlRedirect, service or routeAction.weightedBackendService must be
# set.
# Corresponds to the JSON property `service`
# @return [String]
attr_accessor :service
# Specifies settings for an HTTP redirect.
# Corresponds to the JSON property `urlRedirect`
# @return [Google::Apis::ComputeV1::HttpRedirectAction]
attr_accessor :url_redirect
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@description = args[:description] if args.key?(:description)
@header_action = args[:header_action] if args.key?(:header_action)
@match_rules = args[:match_rules] if args.key?(:match_rules)
@priority = args[:priority] if args.key?(:priority)
@route_action = args[:route_action] if args.key?(:route_action)
@service = args[:service] if args.key?(:service)
@url_redirect = args[:url_redirect] if args.key?(:url_redirect)
end
end
# HttpRouteRuleMatch specifies a set of criteria for matching requests to an
# HttpRouteRule. All specified criteria must be satisfied for a match to occur.
class HttpRouteRuleMatch
include Google::Apis::Core::Hashable
# 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 between 1 and 1024 characters.
# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.
# Corresponds to the JSON property `fullPathMatch`
# @return [String]
attr_accessor :full_path_match
# Specifies a list of header match criteria, all of which must match
# corresponding headers in the request.
# Corresponds to the JSON property `headerMatches`
# @return [Array<Google::Apis::ComputeV1::HttpHeaderMatch>]
attr_accessor :header_matches
# Specifies that prefixMatch and fullPathMatch matches are case sensitive.
# The default value is false.
# ignoreCase must not be used with regexMatch.
# Corresponds to the JSON property `ignoreCase`
# @return [Boolean]
attr_accessor :ignore_case
alias_method :ignore_case?, :ignore_case
# Opaque filter criteria used by Loadbalancer to restrict routing configuration
# to a limited set of xDS compliant clients. In their xDS requests to
# Loadbalancer, xDS clients present node metadata. If a match takes place, 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.
# metadataFilters specified here will be applied after those specified in
# ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.
# metadataFilters only applies to Loadbalancers that have their
# loadBalancingScheme set to INTERNAL_SELF_MANAGED.
# Corresponds to the JSON property `metadataFilters`
# @return [Array<Google::Apis::ComputeV1::MetadataFilter>]
attr_accessor :metadata_filters
# For satisfying the matchRule condition, the request's path must begin with the
# specified prefixMatch. prefixMatch must begin with a /.
# The value must be between 1 and 1024 characters.
# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.
# Corresponds to the JSON property `prefixMatch`
# @return [String]
attr_accessor :prefix_match
# Specifies a list of query parameter match criteria, all of which must match
# corresponding query parameters in the request.
# Corresponds to the JSON property `queryParameterMatches`
# @return [Array<Google::Apis::ComputeV1::HttpQueryParameterMatch>]
attr_accessor :query_parameter_matches
# 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 regular expression
# grammar please see en.cppreference.com/w/cpp/regex/ecmascript
# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.
# Note that regexMatch only applies to Loadbalancers that have their
# loadBalancingScheme set to INTERNAL_SELF_MANAGED.
# Corresponds to the JSON property `regexMatch`
# @return [String]
attr_accessor :regex_match
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@full_path_match = args[:full_path_match] if args.key?(:full_path_match)
@header_matches = args[:header_matches] if args.key?(:header_matches)
@ignore_case = args[:ignore_case] if args.key?(:ignore_case)
@metadata_filters = args[:metadata_filters] if args.key?(:metadata_filters)
@prefix_match = args[:prefix_match] if args.key?(:prefix_match)
@query_parameter_matches = args[:query_parameter_matches] if args.key?(:query_parameter_matches)
@regex_match = args[:regex_match] if args.key?(:regex_match)
end
end
# Represents a legacy HTTPS Health Check resource.
# Legacy health checks are required by network load balancers. For more
# information, read Health Check Concepts.
class HttpsHealthCheck
include Google::Apis::Core::Hashable
# How often (in seconds) to send a health check. The default value is 5 seconds.
# Corresponds to the JSON property `checkIntervalSec`
# @return [Fixnum]
attr_accessor :check_interval_sec
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# A so-far unhealthy instance will be marked healthy after this many consecutive
# successes. The default value is 2.
# Corresponds to the JSON property `healthyThreshold`
# @return [Fixnum]
attr_accessor :healthy_threshold
# The value of the host header in the HTTPS health check request. If left empty (
# default value), the public IP on behalf of which this health check is
# performed will be used.
# Corresponds to the JSON property `host`
# @return [String]
attr_accessor :host
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# Type of the resource.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The TCP port number for the HTTPS health check request. The default value is
# 443.
# Corresponds to the JSON property `port`
# @return [Fixnum]
attr_accessor :port
# The request path of the HTTPS health check request. The default value is "/".
# Corresponds to the JSON property `requestPath`
# @return [String]
attr_accessor :request_path
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# How long (in seconds) to wait before claiming failure. The default value is 5
# seconds. It is invalid for timeoutSec to have a greater value than
# checkIntervalSec.
# Corresponds to the JSON property `timeoutSec`
# @return [Fixnum]
attr_accessor :timeout_sec
# A so-far healthy instance will be marked unhealthy after this many consecutive
# failures. The default value is 2.
# Corresponds to the JSON property `unhealthyThreshold`
# @return [Fixnum]
attr_accessor :unhealthy_threshold
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@check_interval_sec = args[:check_interval_sec] if args.key?(:check_interval_sec)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@healthy_threshold = args[:healthy_threshold] if args.key?(:healthy_threshold)
@host = args[:host] if args.key?(:host)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@port = args[:port] if args.key?(:port)
@request_path = args[:request_path] if args.key?(:request_path)
@self_link = args[:self_link] if args.key?(:self_link)
@timeout_sec = args[:timeout_sec] if args.key?(:timeout_sec)
@unhealthy_threshold = args[:unhealthy_threshold] if args.key?(:unhealthy_threshold)
end
end
# Contains a list of HttpsHealthCheck resources.
class HttpsHealthCheckList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of HttpsHealthCheck resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::HttpsHealthCheck>]
attr_accessor :items
# Type of resource.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::HttpsHealthCheckList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::HttpsHealthCheckList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Represents an Image resource.
# You can use images to create boot disks for your VM instances. For more
# information, read Images. (== resource_for `$api_version`.images ==)
class Image
include Google::Apis::Core::Hashable
# Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
# Corresponds to the JSON property `archiveSizeBytes`
# @return [Fixnum]
attr_accessor :archive_size_bytes
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# Deprecation status for a public resource.
# Corresponds to the JSON property `deprecated`
# @return [Google::Apis::ComputeV1::DeprecationStatus]
attr_accessor :deprecated
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Size of the image when restored onto a persistent disk (in GB).
# Corresponds to the JSON property `diskSizeGb`
# @return [Fixnum]
attr_accessor :disk_size_gb
# The name of the image family to which this image belongs. You can create disks
# by specifying an image family instead of a specific image name. The image
# family always returns its latest image that is not deprecated. The name of the
# image family must comply with RFC1035.
# Corresponds to the JSON property `family`
# @return [String]
attr_accessor :family
# 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.
# Corresponds to the JSON property `guestOsFeatures`
# @return [Array<Google::Apis::ComputeV1::GuestOsFeature>]
attr_accessor :guest_os_features
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# Represents a customer-supplied encryption key
# Corresponds to the JSON property `imageEncryptionKey`
# @return [Google::Apis::ComputeV1::CustomerEncryptionKey]
attr_accessor :image_encryption_key
# [Output Only] Type of the resource. Always compute#image for images.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# A fingerprint for the labels being applied to this image, which is essentially
# a hash of the labels 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 an image.
# Corresponds to the JSON property `labelFingerprint`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :label_fingerprint
# Labels to apply to this image. These can be later modified by the setLabels
# method.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
# Integer license codes indicating which licenses are attached to this image.
# Corresponds to the JSON property `licenseCodes`
# @return [Array<Fixnum>]
attr_accessor :license_codes
# Any applicable license URI.
# Corresponds to the JSON property `licenses`
# @return [Array<String>]
attr_accessor :licenses
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The parameters of the raw disk image.
# Corresponds to the JSON property `rawDisk`
# @return [Google::Apis::ComputeV1::Image::RawDisk]
attr_accessor :raw_disk
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# Initial State for shielded instance, these are public keys which are safe to
# store in public
# Corresponds to the JSON property `shieldedInstanceInitialState`
# @return [Google::Apis::ComputeV1::InitialStateConfig]
attr_accessor :shielded_instance_initial_state
# URL of the source disk used to create this image. This can be a full or valid
# partial URL. You must provide either this property or the rawDisk.source
# property but not both to create an image. For example, the following are valid
# values:
# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
# - projects/project/zones/zone/disks/disk
# - zones/zone/disks/disk
# Corresponds to the JSON property `sourceDisk`
# @return [String]
attr_accessor :source_disk
# Represents a customer-supplied encryption key
# Corresponds to the JSON property `sourceDiskEncryptionKey`
# @return [Google::Apis::ComputeV1::CustomerEncryptionKey]
attr_accessor :source_disk_encryption_key
# [Output Only] The ID value of the disk used to create this image. This value
# may be used to determine whether the image was taken from the current or a
# previous instance of a given disk name.
# Corresponds to the JSON property `sourceDiskId`
# @return [String]
attr_accessor :source_disk_id
# URL of the source image used to create this image.
# In order to create an image, you must provide the full or partial URL of one
# of the following:
# - The selfLink URL
# - This property
# - The rawDisk.source URL
# - The sourceDisk URL
# Corresponds to the JSON property `sourceImage`
# @return [String]
attr_accessor :source_image
# Represents a customer-supplied encryption key
# Corresponds to the JSON property `sourceImageEncryptionKey`
# @return [Google::Apis::ComputeV1::CustomerEncryptionKey]
attr_accessor :source_image_encryption_key
# [Output Only] The ID value of the image used to create this image. This value
# may be used to determine whether the image was taken from the current or a
# previous instance of a given image name.
# Corresponds to the JSON property `sourceImageId`
# @return [String]
attr_accessor :source_image_id
# URL of the source snapshot used to create this image.
# In order to create an image, you must provide the full or partial URL of one
# of the following:
# - The selfLink URL
# - This property
# - The sourceImage URL
# - The rawDisk.source URL
# - The sourceDisk URL
# Corresponds to the JSON property `sourceSnapshot`
# @return [String]
attr_accessor :source_snapshot
# Represents a customer-supplied encryption key
# Corresponds to the JSON property `sourceSnapshotEncryptionKey`
# @return [Google::Apis::ComputeV1::CustomerEncryptionKey]
attr_accessor :source_snapshot_encryption_key
# [Output Only] The ID value of the snapshot used to create this image. This
# value may be used to determine whether the snapshot was taken from the current
# or a previous instance of a given snapshot name.
# Corresponds to the JSON property `sourceSnapshotId`
# @return [String]
attr_accessor :source_snapshot_id
# The type of the image used to create this disk. The default and only value is
# RAW
# Corresponds to the JSON property `sourceType`
# @return [String]
attr_accessor :source_type
# [Output Only] The status of the image. An image can be used to create other
# resources, such as instances, only after the image has been successfully
# created and the status is set to READY. Possible values are FAILED, PENDING,
# or READY.
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
# Cloud Storage bucket storage location of the image (regional or multi-regional)
# .
# Corresponds to the JSON property `storageLocations`
# @return [Array<String>]
attr_accessor :storage_locations
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@archive_size_bytes = args[:archive_size_bytes] if args.key?(:archive_size_bytes)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@deprecated = args[:deprecated] if args.key?(:deprecated)
@description = args[:description] if args.key?(:description)
@disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb)
@family = args[:family] if args.key?(:family)
@guest_os_features = args[:guest_os_features] if args.key?(:guest_os_features)
@id = args[:id] if args.key?(:id)
@image_encryption_key = args[:image_encryption_key] if args.key?(:image_encryption_key)
@kind = args[:kind] if args.key?(:kind)
@label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint)
@labels = args[:labels] if args.key?(:labels)
@license_codes = args[:license_codes] if args.key?(:license_codes)
@licenses = args[:licenses] if args.key?(:licenses)
@name = args[:name] if args.key?(:name)
@raw_disk = args[:raw_disk] if args.key?(:raw_disk)
@self_link = args[:self_link] if args.key?(:self_link)
@shielded_instance_initial_state = args[:shielded_instance_initial_state] if args.key?(:shielded_instance_initial_state)
@source_disk = args[:source_disk] if args.key?(:source_disk)
@source_disk_encryption_key = args[:source_disk_encryption_key] if args.key?(:source_disk_encryption_key)
@source_disk_id = args[:source_disk_id] if args.key?(:source_disk_id)
@source_image = args[:source_image] if args.key?(:source_image)
@source_image_encryption_key = args[:source_image_encryption_key] if args.key?(:source_image_encryption_key)
@source_image_id = args[:source_image_id] if args.key?(:source_image_id)
@source_snapshot = args[:source_snapshot] if args.key?(:source_snapshot)
@source_snapshot_encryption_key = args[:source_snapshot_encryption_key] if args.key?(:source_snapshot_encryption_key)
@source_snapshot_id = args[:source_snapshot_id] if args.key?(:source_snapshot_id)
@source_type = args[:source_type] if args.key?(:source_type)
@status = args[:status] if args.key?(:status)
@storage_locations = args[:storage_locations] if args.key?(:storage_locations)
end
# The parameters of the raw disk image.
class RawDisk
include Google::Apis::Core::Hashable
# The format used to encode and transmit the block device, which should be TAR.
# This is just a container and transmission format and not a runtime format.
# Provided by the client when the disk image is created.
# Corresponds to the JSON property `containerType`
# @return [String]
attr_accessor :container_type
# [Deprecated] This field is deprecated. An optional SHA1 checksum of the disk
# image before unpackaging provided by the client when the disk image is created.
# Corresponds to the JSON property `sha1Checksum`
# @return [String]
attr_accessor :sha1_checksum
# The full Google Cloud Storage URL where the disk image is stored. You must
# provide either this property or the sourceDisk property but not both.
# Corresponds to the JSON property `source`
# @return [String]
attr_accessor :source
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@container_type = args[:container_type] if args.key?(:container_type)
@sha1_checksum = args[:sha1_checksum] if args.key?(:sha1_checksum)
@source = args[:source] if args.key?(:source)
end
end
end
# Contains a list of images.
class ImageList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of Image resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::Image>]
attr_accessor :items
# Type of resource.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::ImageList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::ImageList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Initial State for shielded instance, these are public keys which are safe to
# store in public
class InitialStateConfig
include Google::Apis::Core::Hashable
# The Key Database (db).
# Corresponds to the JSON property `dbs`
# @return [Array<Google::Apis::ComputeV1::FileContentBuffer>]
attr_accessor :dbs
# The forbidden key database (dbx).
# Corresponds to the JSON property `dbxs`
# @return [Array<Google::Apis::ComputeV1::FileContentBuffer>]
attr_accessor :dbxs
# The Key Exchange Key (KEK).
# Corresponds to the JSON property `keks`
# @return [Array<Google::Apis::ComputeV1::FileContentBuffer>]
attr_accessor :keks
# The Platform Key (PK).
# Corresponds to the JSON property `pk`
# @return [Google::Apis::ComputeV1::FileContentBuffer]
attr_accessor :pk
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@dbs = args[:dbs] if args.key?(:dbs)
@dbxs = args[:dbxs] if args.key?(:dbxs)
@keks = args[:keks] if args.key?(:keks)
@pk = args[:pk] if args.key?(:pk)
end
end
# Represents an Instance resource.
# An instance is a virtual machine that is hosted on Google Cloud Platform. For
# more information, read Virtual Machine Instances. (== resource_for `$
# api_version`.instances ==)
class Instance
include Google::Apis::Core::Hashable
# 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.
# Corresponds to the JSON property `canIpForward`
# @return [Boolean]
attr_accessor :can_ip_forward
alias_method :can_ip_forward?, :can_ip_forward
# [Output Only] The CPU platform used by this instance.
# Corresponds to the JSON property `cpuPlatform`
# @return [String]
attr_accessor :cpu_platform
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# Whether the resource should be protected against deletion.
# Corresponds to the JSON property `deletionProtection`
# @return [Boolean]
attr_accessor :deletion_protection
alias_method :deletion_protection?, :deletion_protection
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Array of disks associated with this instance. Persistent disks must be created
# before you can assign them.
# Corresponds to the JSON property `disks`
# @return [Array<Google::Apis::ComputeV1::AttachedDisk>]
attr_accessor :disks
# A set of Display Device options
# Corresponds to the JSON property `displayDevice`
# @return [Google::Apis::ComputeV1::DisplayDevice]
attr_accessor :display_device
# 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.
# Corresponds to the JSON property `fingerprint`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :fingerprint
# A list of the type and count of accelerator cards attached to the instance.
# Corresponds to the JSON property `guestAccelerators`
# @return [Array<Google::Apis::ComputeV1::AcceleratorConfig>]
attr_accessor :guest_accelerators
# 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.
# Corresponds to the JSON property `hostname`
# @return [String]
attr_accessor :hostname
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] Type of the resource. Always compute#instance for instances.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# 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.
# Corresponds to the JSON property `labelFingerprint`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :label_fingerprint
# Labels to apply to this instance. These can be later modified by the setLabels
# method.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
# 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.
# Corresponds to the JSON property `machineType`
# @return [String]
attr_accessor :machine_type
# A metadata key/value entry.
# Corresponds to the JSON property `metadata`
# @return [Google::Apis::ComputeV1::Metadata]
attr_accessor :metadata
# Specifies a minimum CPU platform for the VM instance. Applicable values are
# the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell"
# or minCpuPlatform: "Intel Sandy Bridge".
# Corresponds to the JSON property `minCpuPlatform`
# @return [String]
attr_accessor :min_cpu_platform
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# 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.
# Corresponds to the JSON property `networkInterfaces`
# @return [Array<Google::Apis::ComputeV1::NetworkInterface>]
attr_accessor :network_interfaces
# The private IPv6 google access type for the VM. If not specified, use
# INHERIT_FROM_SUBNETWORK as default.
# Corresponds to the JSON property `privateIpv6GoogleAccess`
# @return [String]
attr_accessor :private_ipv6_google_access
# Specifies the reservations that this instance can consume from.
# Corresponds to the JSON property `reservationAffinity`
# @return [Google::Apis::ComputeV1::ReservationAffinity]
attr_accessor :reservation_affinity
# Resource policies applied to this instance.
# Corresponds to the JSON property `resourcePolicies`
# @return [Array<String>]
attr_accessor :resource_policies
# Sets the scheduling options for an Instance. NextID: 12
# Corresponds to the JSON property `scheduling`
# @return [Google::Apis::ComputeV1::Scheduling]
attr_accessor :scheduling
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# 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.
# Corresponds to the JSON property `serviceAccounts`
# @return [Array<Google::Apis::ComputeV1::ServiceAccount>]
attr_accessor :service_accounts
# A set of Shielded Instance options.
# Corresponds to the JSON property `shieldedInstanceConfig`
# @return [Google::Apis::ComputeV1::ShieldedInstanceConfig]
attr_accessor :shielded_instance_config
# The policy describes the baseline against which Instance boot integrity is
# measured.
# Corresponds to the JSON property `shieldedInstanceIntegrityPolicy`
# @return [Google::Apis::ComputeV1::ShieldedInstanceIntegrityPolicy]
attr_accessor :shielded_instance_integrity_policy
# [Output Only] Whether a VM has been restricted for start because Compute
# Engine has detected suspicious activity.
# Corresponds to the JSON property `startRestricted`
# @return [Boolean]
attr_accessor :start_restricted
alias_method :start_restricted?, :start_restricted
# [Output Only] The status of the instance. One of the following values:
# PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING,
# and TERMINATED.
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
# [Output Only] An optional, human-readable explanation of the status.
# Corresponds to the JSON property `statusMessage`
# @return [String]
attr_accessor :status_message
# A set of instance tags.
# Corresponds to the JSON property `tags`
# @return [Google::Apis::ComputeV1::Tags]
attr_accessor :tags
# [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.
# Corresponds to the JSON property `zone`
# @return [String]
attr_accessor :zone
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@can_ip_forward = args[:can_ip_forward] if args.key?(:can_ip_forward)
@cpu_platform = args[:cpu_platform] if args.key?(:cpu_platform)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@deletion_protection = args[:deletion_protection] if args.key?(:deletion_protection)
@description = args[:description] if args.key?(:description)
@disks = args[:disks] if args.key?(:disks)
@display_device = args[:display_device] if args.key?(:display_device)
@fingerprint = args[:fingerprint] if args.key?(:fingerprint)
@guest_accelerators = args[:guest_accelerators] if args.key?(:guest_accelerators)
@hostname = args[:hostname] if args.key?(:hostname)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint)
@labels = args[:labels] if args.key?(:labels)
@machine_type = args[:machine_type] if args.key?(:machine_type)
@metadata = args[:metadata] if args.key?(:metadata)
@min_cpu_platform = args[:min_cpu_platform] if args.key?(:min_cpu_platform)
@name = args[:name] if args.key?(:name)
@network_interfaces = args[:network_interfaces] if args.key?(:network_interfaces)
@private_ipv6_google_access = args[:private_ipv6_google_access] if args.key?(:private_ipv6_google_access)
@reservation_affinity = args[:reservation_affinity] if args.key?(:reservation_affinity)
@resource_policies = args[:resource_policies] if args.key?(:resource_policies)
@scheduling = args[:scheduling] if args.key?(:scheduling)
@self_link = args[:self_link] if args.key?(:self_link)
@service_accounts = args[:service_accounts] if args.key?(:service_accounts)
@shielded_instance_config = args[:shielded_instance_config] if args.key?(:shielded_instance_config)
@shielded_instance_integrity_policy = args[:shielded_instance_integrity_policy] if args.key?(:shielded_instance_integrity_policy)
@start_restricted = args[:start_restricted] if args.key?(:start_restricted)
@status = args[:status] if args.key?(:status)
@status_message = args[:status_message] if args.key?(:status_message)
@tags = args[:tags] if args.key?(:tags)
@zone = args[:zone] if args.key?(:zone)
end
end
#
class InstanceAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# An object that contains a list of instances scoped by zone.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::InstancesScopedList>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#instanceAggregatedList for
# aggregated lists of Instance resources.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::InstanceAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::InstanceAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Represents an Instance Group resource.
# Instance Groups can be used to configure a target for load balancing.
# Instance groups can either be managed or unmanaged.
# To create managed instance groups, use the instanceGroupManager or
# regionInstanceGroupManager resource instead.
# Use zonal unmanaged instance groups if you need to apply load balancing to
# groups of heterogeneous instances or if you need to manage the instances
# yourself. You cannot create regional unmanaged instance groups.
# For more information, read Instance groups.
# (== resource_for `$api_version`.instanceGroups ==) (== resource_for `$
# api_version`.regionInstanceGroups ==)
class InstanceGroup
include Google::Apis::Core::Hashable
# [Output Only] The creation timestamp for this instance group in RFC3339 text
# format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] The fingerprint of the named ports. The system uses this
# fingerprint to detect conflicts when multiple users change the named ports
# concurrently.
# Corresponds to the JSON property `fingerprint`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :fingerprint
# [Output Only] A unique identifier for this instance group, generated by the
# server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] The resource type, which is always compute#instanceGroup for
# instance groups.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# The name of the instance group. The name must be 1-63 characters long, and
# comply with RFC1035.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Assigns a name to a port number. For example: `name: "http", port: 80`
# This allows the system to reference ports by the assigned name instead of a
# port number. Named ports can also contain multiple ports. For example: [`name:
# "http", port: 80`,`name: "http", port: 8080`]
# Named ports apply to all instances in this instance group.
# Corresponds to the JSON property `namedPorts`
# @return [Array<Google::Apis::ComputeV1::NamedPort>]
attr_accessor :named_ports
# [Output Only] The URL of the network to which all instances in the instance
# group belong. If your instance has multiple network interfaces, then the
# network and subnetwork fields only refer to the network and subnet used by
# your primary interface (nic0).
# Corresponds to the JSON property `network`
# @return [String]
attr_accessor :network
# [Output Only] The URL of the region where the instance group is located (for
# regional resources).
# Corresponds to the JSON property `region`
# @return [String]
attr_accessor :region
# [Output Only] The URL for this instance group. The server generates this URL.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] The total number of instances in the instance group.
# Corresponds to the JSON property `size`
# @return [Fixnum]
attr_accessor :size
# [Output Only] The URL of the subnetwork to which all instances in the instance
# group belong. If your instance has multiple network interfaces, then the
# network and subnetwork fields only refer to the network and subnet used by
# your primary interface (nic0).
# Corresponds to the JSON property `subnetwork`
# @return [String]
attr_accessor :subnetwork
# [Output Only] The URL of the zone where the instance group is located (for
# zonal resources).
# Corresponds to the JSON property `zone`
# @return [String]
attr_accessor :zone
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@fingerprint = args[:fingerprint] if args.key?(:fingerprint)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@named_ports = args[:named_ports] if args.key?(:named_ports)
@network = args[:network] if args.key?(:network)
@region = args[:region] if args.key?(:region)
@self_link = args[:self_link] if args.key?(:self_link)
@size = args[:size] if args.key?(:size)
@subnetwork = args[:subnetwork] if args.key?(:subnetwork)
@zone = args[:zone] if args.key?(:zone)
end
end
#
class InstanceGroupAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of InstanceGroupsScopedList resources.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::InstanceGroupsScopedList>]
attr_accessor :items
# [Output Only] The resource type, which is always compute#
# instanceGroupAggregatedList for aggregated lists of instance groups.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::InstanceGroupAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::InstanceGroupAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# A list of InstanceGroup resources.
class InstanceGroupList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of InstanceGroup resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::InstanceGroup>]
attr_accessor :items
# [Output Only] The resource type, which is always compute#instanceGroupList for
# instance group lists.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::InstanceGroupList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::InstanceGroupList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Represents a Managed Instance Group resource.
# An instance group is a collection of VM instances that you can manage as a
# single entity. For more information, read Instance groups.
# For zonal Managed Instance Group, use the instanceGroupManagers resource.
# For regional Managed Instance Group, use the regionInstanceGroupManagers
# resource. (== resource_for `$api_version`.instanceGroupManagers ==) (==
# resource_for `$api_version`.regionInstanceGroupManagers ==)
class InstanceGroupManager
include Google::Apis::Core::Hashable
# The autohealing policy for this managed instance group. You can specify only
# one value.
# Corresponds to the JSON property `autoHealingPolicies`
# @return [Array<Google::Apis::ComputeV1::InstanceGroupManagerAutoHealingPolicy>]
attr_accessor :auto_healing_policies
# The base instance name to use for instances in this group. The value must be 1-
# 58 characters long. Instances are named by appending a hyphen and a random
# four-character string to the base instance name. The base instance name must
# comply with RFC1035.
# Corresponds to the JSON property `baseInstanceName`
# @return [String]
attr_accessor :base_instance_name
# [Output Only] The creation timestamp for this managed instance group in
# RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# [Output Only] The list of instance actions and the number of instances in this
# managed instance group that are scheduled for each of those actions.
# Corresponds to the JSON property `currentActions`
# @return [Google::Apis::ComputeV1::InstanceGroupManagerActionsSummary]
attr_accessor :current_actions
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Policy specifying intended distribution of instances in regional managed
# instance group.
# Corresponds to the JSON property `distributionPolicy`
# @return [Google::Apis::ComputeV1::DistributionPolicy]
attr_accessor :distribution_policy
# Fingerprint of this resource. This field may be used in optimistic locking. It
# will be ignored when inserting an InstanceGroupManager. An up-to-date
# fingerprint must be provided in order to update the InstanceGroupManager,
# otherwise the request will fail with error 412 conditionNotMet.
# To see the latest fingerprint, make a get() request to retrieve an
# InstanceGroupManager.
# Corresponds to the JSON property `fingerprint`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :fingerprint
# [Output Only] A unique identifier for this resource type. The server generates
# this identifier.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] The URL of the Instance Group resource.
# Corresponds to the JSON property `instanceGroup`
# @return [String]
attr_accessor :instance_group
# The URL of the instance template that is specified for this managed instance
# group. The group uses this template to create all new instances in the managed
# instance group.
# Corresponds to the JSON property `instanceTemplate`
# @return [String]
attr_accessor :instance_template
# [Output Only] The resource type, which is always compute#instanceGroupManager
# for managed instance groups.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# The name of the managed instance group. The name must be 1-63 characters long,
# and comply with RFC1035.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Named ports configured for the Instance Groups complementary to this Instance
# Group Manager.
# Corresponds to the JSON property `namedPorts`
# @return [Array<Google::Apis::ComputeV1::NamedPort>]
attr_accessor :named_ports
# [Output Only] The URL of the region where the managed instance group resides (
# for regional resources).
# Corresponds to the JSON property `region`
# @return [String]
attr_accessor :region
# [Output Only] The URL for this managed instance group. The server defines this
# URL.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] The status of this managed instance group.
# Corresponds to the JSON property `status`
# @return [Google::Apis::ComputeV1::InstanceGroupManagerStatus]
attr_accessor :status
# The URLs for all TargetPool resources to which instances in the instanceGroup
# field are added. The target pools automatically apply to all of the instances
# in the managed instance group.
# Corresponds to the JSON property `targetPools`
# @return [Array<String>]
attr_accessor :target_pools
# The target number of running instances for this managed instance group. You
# can reduce this number by using the instanceGroupManager deleteInstances or
# abandonInstances methods. Resizing the group also changes this number.
# Corresponds to the JSON property `targetSize`
# @return [Fixnum]
attr_accessor :target_size
# The update policy for this managed instance group.
# Corresponds to the JSON property `updatePolicy`
# @return [Google::Apis::ComputeV1::InstanceGroupManagerUpdatePolicy]
attr_accessor :update_policy
# Specifies the instance templates used by this managed instance group to create
# instances.
# Each version is defined by an instanceTemplate and a name. Every version can
# appear at most once per instance group. This field overrides the top-level
# instanceTemplate field. Read more about the relationships between these fields.
# Exactly one version must leave the targetSize field unset. That version will
# be applied to all remaining instances. For more information, read about canary
# updates.
# Corresponds to the JSON property `versions`
# @return [Array<Google::Apis::ComputeV1::InstanceGroupManagerVersion>]
attr_accessor :versions
# [Output Only] The URL of the zone where the managed instance group is located (
# for zonal resources).
# Corresponds to the JSON property `zone`
# @return [String]
attr_accessor :zone
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@auto_healing_policies = args[:auto_healing_policies] if args.key?(:auto_healing_policies)
@base_instance_name = args[:base_instance_name] if args.key?(:base_instance_name)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@current_actions = args[:current_actions] if args.key?(:current_actions)
@description = args[:description] if args.key?(:description)
@distribution_policy = args[:distribution_policy] if args.key?(:distribution_policy)
@fingerprint = args[:fingerprint] if args.key?(:fingerprint)
@id = args[:id] if args.key?(:id)
@instance_group = args[:instance_group] if args.key?(:instance_group)
@instance_template = args[:instance_template] if args.key?(:instance_template)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@named_ports = args[:named_ports] if args.key?(:named_ports)
@region = args[:region] if args.key?(:region)
@self_link = args[:self_link] if args.key?(:self_link)
@status = args[:status] if args.key?(:status)
@target_pools = args[:target_pools] if args.key?(:target_pools)
@target_size = args[:target_size] if args.key?(:target_size)
@update_policy = args[:update_policy] if args.key?(:update_policy)
@versions = args[:versions] if args.key?(:versions)
@zone = args[:zone] if args.key?(:zone)
end
end
#
class InstanceGroupManagerActionsSummary
include Google::Apis::Core::Hashable
# [Output Only] The total number of instances in the managed instance group that
# are scheduled to be abandoned. Abandoning an instance removes it from the
# managed instance group without deleting it.
# Corresponds to the JSON property `abandoning`
# @return [Fixnum]
attr_accessor :abandoning
# [Output Only] The number of instances in the managed instance group that are
# scheduled to be created or are currently being created. If the group fails to
# create any of these instances, it tries again until it creates the instance
# successfully.
# If you have disabled creation retries, this field will not be populated;
# instead, the creatingWithoutRetries field will be populated.
# Corresponds to the JSON property `creating`
# @return [Fixnum]
attr_accessor :creating
# [Output Only] The number of instances that the managed instance group will
# attempt to create. The group attempts to create each instance only once. If
# the group fails to create any of these instances, it decreases the group's
# targetSize value accordingly.
# Corresponds to the JSON property `creatingWithoutRetries`
# @return [Fixnum]
attr_accessor :creating_without_retries
# [Output Only] The number of instances in the managed instance group that are
# scheduled to be deleted or are currently being deleted.
# Corresponds to the JSON property `deleting`
# @return [Fixnum]
attr_accessor :deleting
# [Output Only] The number of instances in the managed instance group that are
# running and have no scheduled actions.
# Corresponds to the JSON property `none`
# @return [Fixnum]
attr_accessor :none
# [Output Only] The number of instances in the managed instance group that are
# scheduled to be recreated or are currently being being recreated. Recreating
# an instance deletes the existing root persistent disk and creates a new disk
# from the image that is defined in the instance template.
# Corresponds to the JSON property `recreating`
# @return [Fixnum]
attr_accessor :recreating
# [Output Only] The number of instances in the managed instance group that are
# being reconfigured with properties that do not require a restart or a recreate
# action. For example, setting or removing target pools for the instance.
# Corresponds to the JSON property `refreshing`
# @return [Fixnum]
attr_accessor :refreshing
# [Output Only] The number of instances in the managed instance group that are
# scheduled to be restarted or are currently being restarted.
# Corresponds to the JSON property `restarting`
# @return [Fixnum]
attr_accessor :restarting
# [Output Only] The number of instances in the managed instance group that are
# being verified. See the managedInstances[].currentAction property in the
# listManagedInstances method documentation.
# Corresponds to the JSON property `verifying`
# @return [Fixnum]
attr_accessor :verifying
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@abandoning = args[:abandoning] if args.key?(:abandoning)
@creating = args[:creating] if args.key?(:creating)
@creating_without_retries = args[:creating_without_retries] if args.key?(:creating_without_retries)
@deleting = args[:deleting] if args.key?(:deleting)
@none = args[:none] if args.key?(:none)
@recreating = args[:recreating] if args.key?(:recreating)
@refreshing = args[:refreshing] if args.key?(:refreshing)
@restarting = args[:restarting] if args.key?(:restarting)
@verifying = args[:verifying] if args.key?(:verifying)
end
end
#
class InstanceGroupManagerAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of InstanceGroupManagersScopedList resources.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::InstanceGroupManagersScopedList>]
attr_accessor :items
# [Output Only] The resource type, which is always compute#
# instanceGroupManagerAggregatedList for an aggregated list of managed instance
# groups.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::InstanceGroupManagerAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::InstanceGroupManagerAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class InstanceGroupManagerAutoHealingPolicy
include Google::Apis::Core::Hashable
# The URL for the health check that signals autohealing.
# Corresponds to the JSON property `healthCheck`
# @return [String]
attr_accessor :health_check
# The number of seconds that the managed instance group waits before it applies
# autohealing policies to new instances or recently recreated instances. This
# initial delay allows instances to initialize and run their startup scripts
# before the instance group determines that they are UNHEALTHY. This prevents
# the managed instance group from recreating its instances prematurely. This
# value must be from range [0, 3600].
# Corresponds to the JSON property `initialDelaySec`
# @return [Fixnum]
attr_accessor :initial_delay_sec
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@health_check = args[:health_check] if args.key?(:health_check)
@initial_delay_sec = args[:initial_delay_sec] if args.key?(:initial_delay_sec)
end
end
# [Output Only] A list of managed instance groups.
class InstanceGroupManagerList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of InstanceGroupManager resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::InstanceGroupManager>]
attr_accessor :items
# [Output Only] The resource type, which is always compute#
# instanceGroupManagerList for a list of managed instance groups.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::InstanceGroupManagerList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::InstanceGroupManagerList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class InstanceGroupManagerStatus
include Google::Apis::Core::Hashable
# [Output Only] The URL of the Autoscaler that targets this instance group
# manager.
# Corresponds to the JSON property `autoscaler`
# @return [String]
attr_accessor :autoscaler
# [Output Only] A bit indicating whether the managed instance group is in a
# stable state. A stable state means that: none of the instances in the managed
# instance group is currently undergoing any type of change (for example,
# creation, restart, or deletion); no future changes are scheduled for instances
# in the managed instance group; and the managed instance group itself is not
# being modified.
# Corresponds to the JSON property `isStable`
# @return [Boolean]
attr_accessor :is_stable
alias_method :is_stable?, :is_stable
# [Output Only] A status of consistency of Instances' versions with their target
# version specified by version field on Instance Group Manager.
# Corresponds to the JSON property `versionTarget`
# @return [Google::Apis::ComputeV1::InstanceGroupManagerStatusVersionTarget]
attr_accessor :version_target
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@autoscaler = args[:autoscaler] if args.key?(:autoscaler)
@is_stable = args[:is_stable] if args.key?(:is_stable)
@version_target = args[:version_target] if args.key?(:version_target)
end
end
#
class InstanceGroupManagerStatusVersionTarget
include Google::Apis::Core::Hashable
# [Output Only] A bit indicating whether version target has been reached in this
# managed instance group, i.e. all instances are in their target version.
# Instances' target version are specified by version field on Instance Group
# Manager.
# Corresponds to the JSON property `isReached`
# @return [Boolean]
attr_accessor :is_reached
alias_method :is_reached?, :is_reached
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@is_reached = args[:is_reached] if args.key?(:is_reached)
end
end
#
class InstanceGroupManagerUpdatePolicy
include Google::Apis::Core::Hashable
# The instance redistribution policy for regional managed instance groups.
# Valid values are:
# - PROACTIVE (default): The group attempts to maintain an even distribution of
# VM instances across zones in the region.
# - NONE: For non-autoscaled groups, proactive redistribution is disabled.
# Corresponds to the JSON property `instanceRedistributionType`
# @return [String]
attr_accessor :instance_redistribution_type
# Encapsulates numeric value that can be either absolute or relative.
# Corresponds to the JSON property `maxSurge`
# @return [Google::Apis::ComputeV1::FixedOrPercent]
attr_accessor :max_surge
# Encapsulates numeric value that can be either absolute or relative.
# Corresponds to the JSON property `maxUnavailable`
# @return [Google::Apis::ComputeV1::FixedOrPercent]
attr_accessor :max_unavailable
# Minimal action to be taken on an instance. You can specify either RESTART to
# restart existing instances or REPLACE to delete and create new instances from
# the target template. If you specify a RESTART, the Updater will attempt to
# perform that action only. However, if the Updater determines that the minimal
# action you specify is not enough to perform the update, it might perform a
# more disruptive action.
# Corresponds to the JSON property `minimalAction`
# @return [String]
attr_accessor :minimal_action
# What action should be used to replace instances. See minimal_action.REPLACE
# Corresponds to the JSON property `replacementMethod`
# @return [String]
attr_accessor :replacement_method
# The type of update process. You can specify either PROACTIVE so that the
# instance group manager proactively executes actions in order to bring
# instances to their target versions or OPPORTUNISTIC so that no action is
# proactively executed but the update will be performed as part of other actions
# (for example, resizes or recreateInstances calls).
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@instance_redistribution_type = args[:instance_redistribution_type] if args.key?(:instance_redistribution_type)
@max_surge = args[:max_surge] if args.key?(:max_surge)
@max_unavailable = args[:max_unavailable] if args.key?(:max_unavailable)
@minimal_action = args[:minimal_action] if args.key?(:minimal_action)
@replacement_method = args[:replacement_method] if args.key?(:replacement_method)
@type = args[:type] if args.key?(:type)
end
end
#
class InstanceGroupManagerVersion
include Google::Apis::Core::Hashable
# The URL of the instance template that is specified for this managed instance
# group. The group uses this template to create new instances in the managed
# instance group until the `targetSize` for this version is reached.
# Corresponds to the JSON property `instanceTemplate`
# @return [String]
attr_accessor :instance_template
# Name of the version. Unique among all versions in the scope of this managed
# instance group.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Encapsulates numeric value that can be either absolute or relative.
# Corresponds to the JSON property `targetSize`
# @return [Google::Apis::ComputeV1::FixedOrPercent]
attr_accessor :target_size
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@instance_template = args[:instance_template] if args.key?(:instance_template)
@name = args[:name] if args.key?(:name)
@target_size = args[:target_size] if args.key?(:target_size)
end
end
#
class InstanceGroupManagersAbandonInstancesRequest
include Google::Apis::Core::Hashable
# The URLs of one or more instances to abandon. This can be a full URL or a
# partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
# Corresponds to the JSON property `instances`
# @return [Array<String>]
attr_accessor :instances
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@instances = args[:instances] if args.key?(:instances)
end
end
# InstanceGroupManagers.applyUpdatesToInstances
class InstanceGroupManagersApplyUpdatesRequest
include Google::Apis::Core::Hashable
# The list of URLs of one or more instances for which you want to apply updates.
# Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[
# INSTANCE_NAME].
# Corresponds to the JSON property `instances`
# @return [Array<String>]
attr_accessor :instances
# The minimal action that you want to perform on each instance during the update:
#
# - REPLACE: At minimum, delete the instance and create it again.
# - RESTART: Stop the instance and start it again.
# - REFRESH: Do not stop the instance.
# - NONE: Do not disrupt the instance at all. By default, the minimum action is
# NONE. If your update requires a more disruptive action than you set with this
# flag, the necessary action is performed to execute the update.
# Corresponds to the JSON property `minimalAction`
# @return [String]
attr_accessor :minimal_action
# The most disruptive action that you want to perform on each instance during
# the update:
# - REPLACE: Delete the instance and create it again.
# - RESTART: Stop the instance and start it again.
# - REFRESH: Do not stop the instance.
# - NONE: Do not disrupt the instance at all. By default, the most disruptive
# allowed action is REPLACE. If your update requires a more disruptive action
# than you set with this flag, the update request will fail.
# Corresponds to the JSON property `mostDisruptiveAllowedAction`
# @return [String]
attr_accessor :most_disruptive_allowed_action
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@instances = args[:instances] if args.key?(:instances)
@minimal_action = args[:minimal_action] if args.key?(:minimal_action)
@most_disruptive_allowed_action = args[:most_disruptive_allowed_action] if args.key?(:most_disruptive_allowed_action)
end
end
# InstanceGroupManagers.createInstances
class InstanceGroupManagersCreateInstancesRequest
include Google::Apis::Core::Hashable
# [Required] List of specifications of per-instance configs.
# Corresponds to the JSON property `instances`
# @return [Array<Google::Apis::ComputeV1::PerInstanceConfig>]
attr_accessor :instances
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@instances = args[:instances] if args.key?(:instances)
end
end
#
class InstanceGroupManagersDeleteInstancesRequest
include Google::Apis::Core::Hashable
# The URLs of one or more instances to delete. This can be a full URL or a
# partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
# Corresponds to the JSON property `instances`
# @return [Array<String>]
attr_accessor :instances
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@instances = args[:instances] if args.key?(:instances)
end
end
#
class InstanceGroupManagersListErrorsResponse
include Google::Apis::Core::Hashable
# [Output Only] The list of errors of the managed instance group.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::InstanceManagedByIgmError>]
attr_accessor :items
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@items = args[:items] if args.key?(:items)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
#
class InstanceGroupManagersListManagedInstancesResponse
include Google::Apis::Core::Hashable
# [Output Only] The list of instances in the managed instance group.
# Corresponds to the JSON property `managedInstances`
# @return [Array<Google::Apis::ComputeV1::ManagedInstance>]
attr_accessor :managed_instances
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@managed_instances = args[:managed_instances] if args.key?(:managed_instances)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
#
class InstanceGroupManagersRecreateInstancesRequest
include Google::Apis::Core::Hashable
# The URLs of one or more instances to recreate. This can be a full URL or a
# partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
# Corresponds to the JSON property `instances`
# @return [Array<String>]
attr_accessor :instances
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@instances = args[:instances] if args.key?(:instances)
end
end
#
class InstanceGroupManagersScopedList
include Google::Apis::Core::Hashable
# [Output Only] The list of managed instance groups that are contained in the
# specified project and zone.
# Corresponds to the JSON property `instanceGroupManagers`
# @return [Array<Google::Apis::ComputeV1::InstanceGroupManager>]
attr_accessor :instance_group_managers
# [Output Only] The warning that replaces the list of managed instance groups
# when the list is empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::InstanceGroupManagersScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@instance_group_managers = args[:instance_group_managers] if args.key?(:instance_group_managers)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] The warning that replaces the list of managed instance groups
# when the list is empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::InstanceGroupManagersScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class InstanceGroupManagersSetInstanceTemplateRequest
include Google::Apis::Core::Hashable
# The URL of the instance template that is specified for this managed instance
# group. The group uses this template to create all new instances in the managed
# instance group.
# Corresponds to the JSON property `instanceTemplate`
# @return [String]
attr_accessor :instance_template
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@instance_template = args[:instance_template] if args.key?(:instance_template)
end
end
#
class InstanceGroupManagersSetTargetPoolsRequest
include Google::Apis::Core::Hashable
# The fingerprint of the target pools information. Use this optional property to
# prevent conflicts when multiple users change the target pools settings
# concurrently. Obtain the fingerprint with the instanceGroupManagers.get method.
# Then, include the fingerprint in your request to ensure that you do not
# overwrite changes that were applied from another concurrent request.
# Corresponds to the JSON property `fingerprint`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :fingerprint
# The list of target pool URLs that instances in this managed instance group
# belong to. The managed instance group applies these target pools to all of the
# instances in the group. Existing instances and new instances in the group all
# receive these target pool settings.
# Corresponds to the JSON property `targetPools`
# @return [Array<String>]
attr_accessor :target_pools
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@fingerprint = args[:fingerprint] if args.key?(:fingerprint)
@target_pools = args[:target_pools] if args.key?(:target_pools)
end
end
#
class InstanceGroupsAddInstancesRequest
include Google::Apis::Core::Hashable
# The list of instances to add to the instance group.
# Corresponds to the JSON property `instances`
# @return [Array<Google::Apis::ComputeV1::InstanceReference>]
attr_accessor :instances
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@instances = args[:instances] if args.key?(:instances)
end
end
#
class InstanceGroupsListInstances
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of InstanceWithNamedPorts resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::InstanceWithNamedPorts>]
attr_accessor :items
# [Output Only] The resource type, which is always compute#
# instanceGroupsListInstances for the list of instances in the specified
# instance group.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::InstanceGroupsListInstances::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::InstanceGroupsListInstances::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class InstanceGroupsListInstancesRequest
include Google::Apis::Core::Hashable
# A filter for the state of the instances in the instance group. Valid options
# are ALL or RUNNING. If you do not specify this parameter the list includes all
# instances regardless of their state.
# Corresponds to the JSON property `instanceState`
# @return [String]
attr_accessor :instance_state
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@instance_state = args[:instance_state] if args.key?(:instance_state)
end
end
#
class InstanceGroupsRemoveInstancesRequest
include Google::Apis::Core::Hashable
# The list of instances to remove from the instance group.
# Corresponds to the JSON property `instances`
# @return [Array<Google::Apis::ComputeV1::InstanceReference>]
attr_accessor :instances
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@instances = args[:instances] if args.key?(:instances)
end
end
#
class InstanceGroupsScopedList
include Google::Apis::Core::Hashable
# [Output Only] The list of instance groups that are contained in this scope.
# Corresponds to the JSON property `instanceGroups`
# @return [Array<Google::Apis::ComputeV1::InstanceGroup>]
attr_accessor :instance_groups
# [Output Only] An informational warning that replaces the list of instance
# groups when the list is empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::InstanceGroupsScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@instance_groups = args[:instance_groups] if args.key?(:instance_groups)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] An informational warning that replaces the list of instance
# groups when the list is empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::InstanceGroupsScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class InstanceGroupsSetNamedPortsRequest
include Google::Apis::Core::Hashable
# The fingerprint of the named ports information for this instance group. Use
# this optional property to prevent conflicts when multiple users change the
# named ports settings concurrently. Obtain the fingerprint with the
# instanceGroups.get method. Then, include the fingerprint in your request to
# ensure that you do not overwrite changes that were applied from another
# concurrent request. A request with an incorrect fingerprint will fail with
# error 412 conditionNotMet.
# Corresponds to the JSON property `fingerprint`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :fingerprint
# The list of named ports to set for this instance group.
# Corresponds to the JSON property `namedPorts`
# @return [Array<Google::Apis::ComputeV1::NamedPort>]
attr_accessor :named_ports
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@fingerprint = args[:fingerprint] if args.key?(:fingerprint)
@named_ports = args[:named_ports] if args.key?(:named_ports)
end
end
# Contains a list of instances.
class InstanceList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of Instance resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::Instance>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#instanceList for lists of
# Instance resources.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::InstanceList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::InstanceList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Contains a list of instance referrers.
class InstanceListReferrers
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of Reference resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::Reference>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#instanceListReferrers for lists
# of Instance referrers.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::InstanceListReferrers::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::InstanceListReferrers::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class InstanceManagedByIgmError
include Google::Apis::Core::Hashable
# [Output Only] Contents of the error.
# Corresponds to the JSON property `error`
# @return [Google::Apis::ComputeV1::InstanceManagedByIgmErrorManagedInstanceError]
attr_accessor :error
# [Output Only] Details of the instance action that triggered this error. May be
# null, if the error was not caused by an action on an instance. This field is
# optional.
# Corresponds to the JSON property `instanceActionDetails`
# @return [Google::Apis::ComputeV1::InstanceManagedByIgmErrorInstanceActionDetails]
attr_accessor :instance_action_details
# [Output Only] The time that this error occurred. This value is in RFC3339 text
# format.
# Corresponds to the JSON property `timestamp`
# @return [String]
attr_accessor :timestamp
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@error = args[:error] if args.key?(:error)
@instance_action_details = args[:instance_action_details] if args.key?(:instance_action_details)
@timestamp = args[:timestamp] if args.key?(:timestamp)
end
end
#
class InstanceManagedByIgmErrorInstanceActionDetails
include Google::Apis::Core::Hashable
# [Output Only] Action that managed instance group was executing on the instance
# when the error occurred. Possible values:
# Corresponds to the JSON property `action`
# @return [String]
attr_accessor :action
# [Output Only] The URL of the instance. The URL can be set even if the instance
# has not yet been created.
# Corresponds to the JSON property `instance`
# @return [String]
attr_accessor :instance
# [Output Only] Version this instance was created from, or was being created
# from, but the creation failed. Corresponds to one of the versions that were
# set on the Instance Group Manager resource at the time this instance was being
# created.
# Corresponds to the JSON property `version`
# @return [Google::Apis::ComputeV1::ManagedInstanceVersion]
attr_accessor :version
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@action = args[:action] if args.key?(:action)
@instance = args[:instance] if args.key?(:instance)
@version = args[:version] if args.key?(:version)
end
end
#
class InstanceManagedByIgmErrorManagedInstanceError
include Google::Apis::Core::Hashable
# [Output Only] Error code.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Error message.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@message = args[:message] if args.key?(:message)
end
end
#
class MoveInstanceRequest
include Google::Apis::Core::Hashable
# The URL of the destination zone to move the instance. This can be a full or
# partial URL. For example, the following are all valid URLs to a zone:
# - https://www.googleapis.com/compute/v1/projects/project/zones/zone
# - projects/project/zones/zone
# - zones/zone
# Corresponds to the JSON property `destinationZone`
# @return [String]
attr_accessor :destination_zone
# The URL of the target instance to move. This can be a full or partial URL. For
# example, the following are all valid URLs to an instance:
# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
# instance
# - projects/project/zones/zone/instances/instance
# - zones/zone/instances/instance
# Corresponds to the JSON property `targetInstance`
# @return [String]
attr_accessor :target_instance
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@destination_zone = args[:destination_zone] if args.key?(:destination_zone)
@target_instance = args[:target_instance] if args.key?(:target_instance)
end
end
#
class InstanceProperties
include Google::Apis::Core::Hashable
# Enables instances created based on these properties to send packets with
# source IP addresses other than their own and receive packets with destination
# IP addresses other than their own. If these instances will be used as an IP
# gateway or it will be set as the next-hop in a Route resource, specify true.
# If unsure, leave this set to false. See the Enable IP forwarding documentation
# for more information.
# Corresponds to the JSON property `canIpForward`
# @return [Boolean]
attr_accessor :can_ip_forward
alias_method :can_ip_forward?, :can_ip_forward
# An optional text description for the instances that are created from these
# properties.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# An array of disks that are associated with the instances that are created from
# these properties.
# Corresponds to the JSON property `disks`
# @return [Array<Google::Apis::ComputeV1::AttachedDisk>]
attr_accessor :disks
# A list of guest accelerator cards' type and count to use for instances created
# from these properties.
# Corresponds to the JSON property `guestAccelerators`
# @return [Array<Google::Apis::ComputeV1::AcceleratorConfig>]
attr_accessor :guest_accelerators
# Labels to apply to instances that are created from these properties.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
# The machine type to use for instances that are created from these properties.
# Corresponds to the JSON property `machineType`
# @return [String]
attr_accessor :machine_type
# A metadata key/value entry.
# Corresponds to the JSON property `metadata`
# @return [Google::Apis::ComputeV1::Metadata]
attr_accessor :metadata
# Minimum cpu/platform to be used by instances. The instance may be scheduled on
# the specified or newer cpu/platform. Applicable values are the friendly names
# of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "
# Intel Sandy Bridge". For more information, read Specifying a Minimum CPU
# Platform.
# Corresponds to the JSON property `minCpuPlatform`
# @return [String]
attr_accessor :min_cpu_platform
# An array of network access configurations for this interface.
# Corresponds to the JSON property `networkInterfaces`
# @return [Array<Google::Apis::ComputeV1::NetworkInterface>]
attr_accessor :network_interfaces
# The private IPv6 google access type for VMs. If not specified, use
# INHERIT_FROM_SUBNETWORK as default.
# Corresponds to the JSON property `privateIpv6GoogleAccess`
# @return [String]
attr_accessor :private_ipv6_google_access
# Specifies the reservations that this instance can consume from.
# Corresponds to the JSON property `reservationAffinity`
# @return [Google::Apis::ComputeV1::ReservationAffinity]
attr_accessor :reservation_affinity
# Resource policies (names, not ULRs) applied to instances created from these
# properties.
# Corresponds to the JSON property `resourcePolicies`
# @return [Array<String>]
attr_accessor :resource_policies
# Sets the scheduling options for an Instance. NextID: 12
# Corresponds to the JSON property `scheduling`
# @return [Google::Apis::ComputeV1::Scheduling]
attr_accessor :scheduling
# A list of service accounts with specified scopes. Access tokens for these
# service accounts are available to the instances that are created from these
# properties. Use metadata queries to obtain the access tokens for these
# instances.
# Corresponds to the JSON property `serviceAccounts`
# @return [Array<Google::Apis::ComputeV1::ServiceAccount>]
attr_accessor :service_accounts
# A set of Shielded Instance options.
# Corresponds to the JSON property `shieldedInstanceConfig`
# @return [Google::Apis::ComputeV1::ShieldedInstanceConfig]
attr_accessor :shielded_instance_config
# A set of instance tags.
# Corresponds to the JSON property `tags`
# @return [Google::Apis::ComputeV1::Tags]
attr_accessor :tags
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@can_ip_forward = args[:can_ip_forward] if args.key?(:can_ip_forward)
@description = args[:description] if args.key?(:description)
@disks = args[:disks] if args.key?(:disks)
@guest_accelerators = args[:guest_accelerators] if args.key?(:guest_accelerators)
@labels = args[:labels] if args.key?(:labels)
@machine_type = args[:machine_type] if args.key?(:machine_type)
@metadata = args[:metadata] if args.key?(:metadata)
@min_cpu_platform = args[:min_cpu_platform] if args.key?(:min_cpu_platform)
@network_interfaces = args[:network_interfaces] if args.key?(:network_interfaces)
@private_ipv6_google_access = args[:private_ipv6_google_access] if args.key?(:private_ipv6_google_access)
@reservation_affinity = args[:reservation_affinity] if args.key?(:reservation_affinity)
@resource_policies = args[:resource_policies] if args.key?(:resource_policies)
@scheduling = args[:scheduling] if args.key?(:scheduling)
@service_accounts = args[:service_accounts] if args.key?(:service_accounts)
@shielded_instance_config = args[:shielded_instance_config] if args.key?(:shielded_instance_config)
@tags = args[:tags] if args.key?(:tags)
end
end
#
class InstanceReference
include Google::Apis::Core::Hashable
# The URL for a specific instance.
# Corresponds to the JSON property `instance`
# @return [String]
attr_accessor :instance
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@instance = args[:instance] if args.key?(:instance)
end
end
# Represents an Instance Template resource.
# You can use instance templates to create VM instances and managed instance
# groups. For more information, read Instance Templates. (== resource_for `$
# api_version`.instanceTemplates ==)
class InstanceTemplate
include Google::Apis::Core::Hashable
# [Output Only] The creation timestamp for this instance template in RFC3339
# text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] A unique identifier for this instance template. The server
# defines this identifier.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] The resource type, which is always compute#instanceTemplate for
# instance templates.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
#
# Corresponds to the JSON property `properties`
# @return [Google::Apis::ComputeV1::InstanceProperties]
attr_accessor :properties
# [Output Only] The URL for this instance template. The server defines this URL.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# The source instance used to create the template. You can provide this as a
# partial or full URL to the resource. For example, the following are valid
# values:
# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
# instance
# - projects/project/zones/zone/instances/instance
# Corresponds to the JSON property `sourceInstance`
# @return [String]
attr_accessor :source_instance
# A specification of the parameters to use when creating the instance template
# from a source instance.
# Corresponds to the JSON property `sourceInstanceParams`
# @return [Google::Apis::ComputeV1::SourceInstanceParams]
attr_accessor :source_instance_params
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@properties = args[:properties] if args.key?(:properties)
@self_link = args[:self_link] if args.key?(:self_link)
@source_instance = args[:source_instance] if args.key?(:source_instance)
@source_instance_params = args[:source_instance_params] if args.key?(:source_instance_params)
end
end
# A list of instance templates.
class InstanceTemplateList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of InstanceTemplate resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::InstanceTemplate>]
attr_accessor :items
# [Output Only] The resource type, which is always compute#
# instanceTemplatesListResponse for instance template lists.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::InstanceTemplateList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::InstanceTemplateList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class InstanceWithNamedPorts
include Google::Apis::Core::Hashable
# [Output Only] The URL of the instance.
# Corresponds to the JSON property `instance`
# @return [String]
attr_accessor :instance
# [Output Only] The named ports that belong to this instance group.
# Corresponds to the JSON property `namedPorts`
# @return [Array<Google::Apis::ComputeV1::NamedPort>]
attr_accessor :named_ports
# [Output Only] The status of the instance.
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@instance = args[:instance] if args.key?(:instance)
@named_ports = args[:named_ports] if args.key?(:named_ports)
@status = args[:status] if args.key?(:status)
end
end
#
class InstancesAddResourcePoliciesRequest
include Google::Apis::Core::Hashable
# Resource policies to be added to this instance.
# Corresponds to the JSON property `resourcePolicies`
# @return [Array<String>]
attr_accessor :resource_policies
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@resource_policies = args[:resource_policies] if args.key?(:resource_policies)
end
end
#
class InstancesRemoveResourcePoliciesRequest
include Google::Apis::Core::Hashable
# Resource policies to be removed from this instance.
# Corresponds to the JSON property `resourcePolicies`
# @return [Array<String>]
attr_accessor :resource_policies
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@resource_policies = args[:resource_policies] if args.key?(:resource_policies)
end
end
#
class InstancesScopedList
include Google::Apis::Core::Hashable
# [Output Only] A list of instances contained in this scope.
# Corresponds to the JSON property `instances`
# @return [Array<Google::Apis::ComputeV1::Instance>]
attr_accessor :instances
# [Output Only] Informational warning which replaces the list of instances when
# the list is empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::InstancesScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@instances = args[:instances] if args.key?(:instances)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning which replaces the list of instances when
# the list is empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::InstancesScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class InstancesSetLabelsRequest
include Google::Apis::Core::Hashable
# Fingerprint of the previous set of labels for this resource, used to prevent
# conflicts. Provide the latest fingerprint value when making a request to add
# or change labels.
# Corresponds to the JSON property `labelFingerprint`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :label_fingerprint
#
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint)
@labels = args[:labels] if args.key?(:labels)
end
end
#
class InstancesSetMachineResourcesRequest
include Google::Apis::Core::Hashable
# A list of the type and count of accelerator cards attached to the instance.
# Corresponds to the JSON property `guestAccelerators`
# @return [Array<Google::Apis::ComputeV1::AcceleratorConfig>]
attr_accessor :guest_accelerators
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@guest_accelerators = args[:guest_accelerators] if args.key?(:guest_accelerators)
end
end
#
class InstancesSetMachineTypeRequest
include Google::Apis::Core::Hashable
# Full or partial URL of the machine type resource. See Machine Types for a full
# list of machine types. For example: zones/us-central1-f/machineTypes/n1-
# standard-1
# Corresponds to the JSON property `machineType`
# @return [String]
attr_accessor :machine_type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@machine_type = args[:machine_type] if args.key?(:machine_type)
end
end
#
class InstancesSetMinCpuPlatformRequest
include Google::Apis::Core::Hashable
# Minimum cpu/platform this instance should be started at.
# Corresponds to the JSON property `minCpuPlatform`
# @return [String]
attr_accessor :min_cpu_platform
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@min_cpu_platform = args[:min_cpu_platform] if args.key?(:min_cpu_platform)
end
end
#
class InstancesSetServiceAccountRequest
include Google::Apis::Core::Hashable
# Email address of the service account.
# Corresponds to the JSON property `email`
# @return [String]
attr_accessor :email
# The list of scopes to be made available for this service account.
# Corresponds to the JSON property `scopes`
# @return [Array<String>]
attr_accessor :scopes
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@email = args[:email] if args.key?(:email)
@scopes = args[:scopes] if args.key?(:scopes)
end
end
#
class InstancesStartWithEncryptionKeyRequest
include Google::Apis::Core::Hashable
# Array of disks associated with this instance that are protected with a
# customer-supplied encryption key.
# In order to start the instance, the disk url and its corresponding key must be
# provided.
# If the disk is not protected with a customer-supplied encryption key it should
# not be specified.
# Corresponds to the JSON property `disks`
# @return [Array<Google::Apis::ComputeV1::CustomerEncryptionKeyProtectedDisk>]
attr_accessor :disks
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@disks = args[:disks] if args.key?(:disks)
end
end
# HttpRouteRuleMatch criteria for field values that must stay within the
# specified integer range.
class Int64RangeMatch
include Google::Apis::Core::Hashable
# The end of the range (exclusive) in signed long integer format.
# Corresponds to the JSON property `rangeEnd`
# @return [Fixnum]
attr_accessor :range_end
# The start of the range (inclusive) in signed long integer format.
# Corresponds to the JSON property `rangeStart`
# @return [Fixnum]
attr_accessor :range_start
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@range_end = args[:range_end] if args.key?(:range_end)
@range_start = args[:range_start] if args.key?(:range_start)
end
end
# Represents an Interconnect resource.
# An Interconnect resource is a dedicated connection between the GCP network and
# your on-premises network. For more information, read the Dedicated
# Interconnect Overview. (== resource_for `$api_version`.interconnects ==)
class Interconnect
include Google::Apis::Core::Hashable
# Administrative status of the interconnect. When this is set to true, the
# Interconnect is functional and can carry traffic. When set to false, no
# packets can be carried over the interconnect and no BGP routes are exchanged
# over it. By default, the status is set to true.
# Corresponds to the JSON property `adminEnabled`
# @return [Boolean]
attr_accessor :admin_enabled
alias_method :admin_enabled?, :admin_enabled
# [Output Only] A list of CircuitInfo objects, that describe the individual
# circuits in this LAG.
# Corresponds to the JSON property `circuitInfos`
# @return [Array<Google::Apis::ComputeV1::InterconnectCircuitInfo>]
attr_accessor :circuit_infos
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# Customer name, to put in the Letter of Authorization as the party authorized
# to request a crossconnect.
# Corresponds to the JSON property `customerName`
# @return [String]
attr_accessor :customer_name
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] A list of outages expected for this Interconnect.
# Corresponds to the JSON property `expectedOutages`
# @return [Array<Google::Apis::ComputeV1::InterconnectOutageNotification>]
attr_accessor :expected_outages
# [Output Only] IP address configured on the Google side of the Interconnect
# link. This can be used only for ping tests.
# Corresponds to the JSON property `googleIpAddress`
# @return [String]
attr_accessor :google_ip_address
# [Output Only] Google reference ID to be used when raising support tickets with
# Google or otherwise to debug backend connectivity issues.
# Corresponds to the JSON property `googleReferenceId`
# @return [String]
attr_accessor :google_reference_id
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] A list of the URLs of all InterconnectAttachments configured to
# use this Interconnect.
# Corresponds to the JSON property `interconnectAttachments`
# @return [Array<String>]
attr_accessor :interconnect_attachments
# Type of interconnect, which can take one of the following values:
# - PARTNER: A partner-managed interconnection shared between customers though a
# partner.
# - DEDICATED: A dedicated physical interconnection with the customer. Note that
# a value IT_PRIVATE has been deprecated in favor of DEDICATED.
# Corresponds to the JSON property `interconnectType`
# @return [String]
attr_accessor :interconnect_type
# [Output Only] Type of the resource. Always compute#interconnect for
# interconnects.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Type of link requested, which can take one of the following values:
# - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics
# - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this
# field indicates the speed of each of the links in the bundle, not the speed of
# the entire bundle.
# Corresponds to the JSON property `linkType`
# @return [String]
attr_accessor :link_type
# URL of the InterconnectLocation object that represents where this connection
# is to be provisioned.
# Corresponds to the JSON property `location`
# @return [String]
attr_accessor :location
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Email address to contact the customer NOC for operations and maintenance
# notifications regarding this Interconnect. If specified, this will be used for
# notifications in addition to all other forms described, such as Stackdriver
# logs alerting and Cloud Notifications.
# Corresponds to the JSON property `nocContactEmail`
# @return [String]
attr_accessor :noc_contact_email
# [Output Only] The current status of this Interconnect's functionality, which
# can take one of the following values:
# - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use.
# Attachments may be provisioned on this Interconnect.
# - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No
# attachments may be provisioned on this Interconnect.
# - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal
# maintenance. No attachments may be provisioned or updated on this Interconnect.
# Corresponds to the JSON property `operationalStatus`
# @return [String]
attr_accessor :operational_status
# [Output Only] IP address configured on the customer side of the Interconnect
# link. The customer should configure this IP address during turnup when
# prompted by Google NOC. This can be used only for ping tests.
# Corresponds to the JSON property `peerIpAddress`
# @return [String]
attr_accessor :peer_ip_address
# [Output Only] Number of links actually provisioned in this interconnect.
# Corresponds to the JSON property `provisionedLinkCount`
# @return [Fixnum]
attr_accessor :provisioned_link_count
# Target number of physical links in the link bundle, as requested by the
# customer.
# Corresponds to the JSON property `requestedLinkCount`
# @return [Fixnum]
attr_accessor :requested_link_count
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] The current state of Interconnect functionality, which can take
# one of the following values:
# - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments
# may be provisioned on this Interconnect.
# - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may
# be provisioned on this Interconnect.
# - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No
# attachments may be provisioned or updated on this Interconnect.
# Corresponds to the JSON property `state`
# @return [String]
attr_accessor :state
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@admin_enabled = args[:admin_enabled] if args.key?(:admin_enabled)
@circuit_infos = args[:circuit_infos] if args.key?(:circuit_infos)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@customer_name = args[:customer_name] if args.key?(:customer_name)
@description = args[:description] if args.key?(:description)
@expected_outages = args[:expected_outages] if args.key?(:expected_outages)
@google_ip_address = args[:google_ip_address] if args.key?(:google_ip_address)
@google_reference_id = args[:google_reference_id] if args.key?(:google_reference_id)
@id = args[:id] if args.key?(:id)
@interconnect_attachments = args[:interconnect_attachments] if args.key?(:interconnect_attachments)
@interconnect_type = args[:interconnect_type] if args.key?(:interconnect_type)
@kind = args[:kind] if args.key?(:kind)
@link_type = args[:link_type] if args.key?(:link_type)
@location = args[:location] if args.key?(:location)
@name = args[:name] if args.key?(:name)
@noc_contact_email = args[:noc_contact_email] if args.key?(:noc_contact_email)
@operational_status = args[:operational_status] if args.key?(:operational_status)
@peer_ip_address = args[:peer_ip_address] if args.key?(:peer_ip_address)
@provisioned_link_count = args[:provisioned_link_count] if args.key?(:provisioned_link_count)
@requested_link_count = args[:requested_link_count] if args.key?(:requested_link_count)
@self_link = args[:self_link] if args.key?(:self_link)
@state = args[:state] if args.key?(:state)
end
end
# Represents an Interconnect Attachment (VLAN) resource.
# You can use Interconnect attachments (VLANS) to connect your Virtual Private
# Cloud networks to your on-premises networks through an Interconnect. For more
# information, read Creating VLAN Attachments. (== resource_for `$api_version`.
# interconnectAttachments ==)
class InterconnectAttachment
include Google::Apis::Core::Hashable
# Determines whether this Attachment will carry packets. Not present for
# PARTNER_PROVIDER.
# Corresponds to the JSON property `adminEnabled`
# @return [Boolean]
attr_accessor :admin_enabled
alias_method :admin_enabled?, :admin_enabled
# Provisioned bandwidth capacity for the interconnect attachment. For
# attachments of type DEDICATED, the user can set the bandwidth. For attachments
# of type PARTNER, the Google Partner that is operating the interconnect must
# set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER
# and DEDICATED, and can take one of the following values:
# - BPS_50M: 50 Mbit/s
# - BPS_100M: 100 Mbit/s
# - BPS_200M: 200 Mbit/s
# - BPS_300M: 300 Mbit/s
# - BPS_400M: 400 Mbit/s
# - BPS_500M: 500 Mbit/s
# - BPS_1G: 1 Gbit/s
# - BPS_2G: 2 Gbit/s
# - BPS_5G: 5 Gbit/s
# - BPS_10G: 10 Gbit/s
# - BPS_20G: 20 Gbit/s
# - BPS_50G: 50 Gbit/s
# Corresponds to the JSON property `bandwidth`
# @return [String]
attr_accessor :bandwidth
# Up to 16 candidate prefixes that can be used to restrict the allocation of
# cloudRouterIpAddress and customerRouterIpAddress for this attachment. All
# prefixes must be within link-local address space (169.254.0.0/16) and must be /
# 29 or shorter (/28, /27, etc). Google will attempt to select an unused /29
# from the supplied candidate prefix(es). The request will fail if all possible /
# 29s are in use on Google's edge. If not supplied, Google will randomly select
# an unused /29 from all of link-local space.
# Corresponds to the JSON property `candidateSubnets`
# @return [Array<String>]
attr_accessor :candidate_subnets
# [Output Only] IPv4 address + prefix length to be configured on Cloud Router
# Interface for this interconnect attachment.
# Corresponds to the JSON property `cloudRouterIpAddress`
# @return [String]
attr_accessor :cloud_router_ip_address
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# [Output Only] IPv4 address + prefix length to be configured on the customer
# router subinterface for this interconnect attachment.
# Corresponds to the JSON property `customerRouterIpAddress`
# @return [String]
attr_accessor :customer_router_ip_address
# An optional description of this resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Desired availability domain for the attachment. Only available for type
# PARTNER, at creation time, and can take one of the following values:
# - AVAILABILITY_DOMAIN_ANY
# - AVAILABILITY_DOMAIN_1
# - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a
# pair of attachments, one per availability domain. The selected availability
# domain will be provided to the Partner via the pairing key, so that the
# provisioned circuit will lie in the specified domain. If not specified, the
# value will default to AVAILABILITY_DOMAIN_ANY.
# Corresponds to the JSON property `edgeAvailabilityDomain`
# @return [String]
attr_accessor :edge_availability_domain
# [Output Only] Google reference ID, to be used when raising support tickets
# with Google or otherwise to debug backend connectivity issues. [Deprecated]
# This field is not used.
# Corresponds to the JSON property `googleReferenceId`
# @return [String]
attr_accessor :google_reference_id
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# URL of the underlying Interconnect object that this attachment's traffic will
# traverse through.
# Corresponds to the JSON property `interconnect`
# @return [String]
attr_accessor :interconnect
# [Output Only] Type of the resource. Always compute#interconnectAttachment for
# interconnect attachments.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# [Output Only] The current status of whether or not this interconnect
# attachment is functional, which can take one of the following values:
# - OS_ACTIVE: The attachment has been turned up and is ready to use.
# - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is
# not complete.
# Corresponds to the JSON property `operationalStatus`
# @return [String]
attr_accessor :operational_status
# [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present
# for DEDICATED]. The opaque identifier of an PARTNER attachment used to
# initiate provisioning with a selected partner. Of the form "XXXXX/region/
# domain"
# Corresponds to the JSON property `pairingKey`
# @return [String]
attr_accessor :pairing_key
# Optional BGP ASN for the router supplied by a Layer 3 Partner if they
# configured BGP on behalf of the customer. Output only for PARTNER type, input
# only for PARTNER_PROVIDER, not available for DEDICATED.
# Corresponds to the JSON property `partnerAsn`
# @return [Fixnum]
attr_accessor :partner_asn
# Informational metadata about Partner attachments from Partners to display to
# customers. These fields are propagated from PARTNER_PROVIDER attachments to
# their corresponding PARTNER attachments.
# Corresponds to the JSON property `partnerMetadata`
# @return [Google::Apis::ComputeV1::InterconnectAttachmentPartnerMetadata]
attr_accessor :partner_metadata
# Information for an interconnect attachment when this belongs to an
# interconnect of type DEDICATED.
# Corresponds to the JSON property `privateInterconnectInfo`
# @return [Google::Apis::ComputeV1::InterconnectAttachmentPrivateInfo]
attr_accessor :private_interconnect_info
# [Output Only] URL of the region where the regional interconnect attachment
# resides. You must specify this field as part of the HTTP request URL. It is
# not settable as a field in the request body.
# Corresponds to the JSON property `region`
# @return [String]
attr_accessor :region
# URL of the Cloud Router to be used for dynamic routing. This router must be in
# the same region as this InterconnectAttachment. The InterconnectAttachment
# will automatically connect the Interconnect to the network & region within
# which the Cloud Router is configured.
# Corresponds to the JSON property `router`
# @return [String]
attr_accessor :router
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] The current state of this attachment's functionality. Enum
# values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and
# PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER,
# PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and
# PARTNER_PROVIDER interconnect attachments. This state can take one of the
# following values:
# - ACTIVE: The attachment has been turned up and is ready to use.
# - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not
# complete.
# - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been
# configured on the Partner side.
# - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of
# provisioning after a PARTNER_PROVIDER attachment was created that references
# it.
# - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting
# for a customer to activate it.
# - DEFUNCT: The attachment was deleted externally and is no longer functional.
# This could be because the associated Interconnect was removed, or because the
# other side of a Partner attachment was deleted.
# Corresponds to the JSON property `state`
# @return [String]
attr_accessor :state
# The type of interconnect attachment this is, which can take one of the
# following values:
# - DEDICATED: an attachment to a Dedicated Interconnect.
# - PARTNER: an attachment to a Partner Interconnect, created by the customer.
# - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the
# partner.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
# The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only
# specified at creation time.
# Corresponds to the JSON property `vlanTag8021q`
# @return [Fixnum]
attr_accessor :vlan_tag8021q
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@admin_enabled = args[:admin_enabled] if args.key?(:admin_enabled)
@bandwidth = args[:bandwidth] if args.key?(:bandwidth)
@candidate_subnets = args[:candidate_subnets] if args.key?(:candidate_subnets)
@cloud_router_ip_address = args[:cloud_router_ip_address] if args.key?(:cloud_router_ip_address)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@customer_router_ip_address = args[:customer_router_ip_address] if args.key?(:customer_router_ip_address)
@description = args[:description] if args.key?(:description)
@edge_availability_domain = args[:edge_availability_domain] if args.key?(:edge_availability_domain)
@google_reference_id = args[:google_reference_id] if args.key?(:google_reference_id)
@id = args[:id] if args.key?(:id)
@interconnect = args[:interconnect] if args.key?(:interconnect)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@operational_status = args[:operational_status] if args.key?(:operational_status)
@pairing_key = args[:pairing_key] if args.key?(:pairing_key)
@partner_asn = args[:partner_asn] if args.key?(:partner_asn)
@partner_metadata = args[:partner_metadata] if args.key?(:partner_metadata)
@private_interconnect_info = args[:private_interconnect_info] if args.key?(:private_interconnect_info)
@region = args[:region] if args.key?(:region)
@router = args[:router] if args.key?(:router)
@self_link = args[:self_link] if args.key?(:self_link)
@state = args[:state] if args.key?(:state)
@type = args[:type] if args.key?(:type)
@vlan_tag8021q = args[:vlan_tag8021q] if args.key?(:vlan_tag8021q)
end
end
#
class InterconnectAttachmentAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of InterconnectAttachmentsScopedList resources.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::InterconnectAttachmentsScopedList>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#
# interconnectAttachmentAggregatedList for aggregated lists of interconnect
# attachments.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::InterconnectAttachmentAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::InterconnectAttachmentAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Response to the list request, and contains a list of interconnect attachments.
class InterconnectAttachmentList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of InterconnectAttachment resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::InterconnectAttachment>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#interconnectAttachmentList for
# lists of interconnect attachments.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::InterconnectAttachmentList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::InterconnectAttachmentList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Informational metadata about Partner attachments from Partners to display to
# customers. These fields are propagated from PARTNER_PROVIDER attachments to
# their corresponding PARTNER attachments.
class InterconnectAttachmentPartnerMetadata
include Google::Apis::Core::Hashable
# Plain text name of the Interconnect this attachment is connected to, as
# displayed in the Partner's portal. For instance "Chicago 1". This value may be
# validated to match approved Partner values.
# Corresponds to the JSON property `interconnectName`
# @return [String]
attr_accessor :interconnect_name
# Plain text name of the Partner providing this attachment. This value may be
# validated to match approved Partner values.
# Corresponds to the JSON property `partnerName`
# @return [String]
attr_accessor :partner_name
# URL of the Partner's portal for this Attachment. Partners may customise this
# to be a deep link to the specific resource on the Partner portal. This value
# may be validated to match approved Partner values.
# Corresponds to the JSON property `portalUrl`
# @return [String]
attr_accessor :portal_url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@interconnect_name = args[:interconnect_name] if args.key?(:interconnect_name)
@partner_name = args[:partner_name] if args.key?(:partner_name)
@portal_url = args[:portal_url] if args.key?(:portal_url)
end
end
# Information for an interconnect attachment when this belongs to an
# interconnect of type DEDICATED.
class InterconnectAttachmentPrivateInfo
include Google::Apis::Core::Hashable
# [Output Only] 802.1q encapsulation tag to be used for traffic between Google
# and the customer, going to and from this network and region.
# Corresponds to the JSON property `tag8021q`
# @return [Fixnum]
attr_accessor :tag8021q
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@tag8021q = args[:tag8021q] if args.key?(:tag8021q)
end
end
#
class InterconnectAttachmentsScopedList
include Google::Apis::Core::Hashable
# A list of interconnect attachments contained in this scope.
# Corresponds to the JSON property `interconnectAttachments`
# @return [Array<Google::Apis::ComputeV1::InterconnectAttachment>]
attr_accessor :interconnect_attachments
# Informational warning which replaces the list of addresses when the list is
# empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::InterconnectAttachmentsScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@interconnect_attachments = args[:interconnect_attachments] if args.key?(:interconnect_attachments)
@warning = args[:warning] if args.key?(:warning)
end
# Informational warning which replaces the list of addresses when the list is
# empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::InterconnectAttachmentsScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Describes a single physical circuit between the Customer and Google.
# CircuitInfo objects are created by Google, so all fields are output only.
class InterconnectCircuitInfo
include Google::Apis::Core::Hashable
# Customer-side demarc ID for this circuit.
# Corresponds to the JSON property `customerDemarcId`
# @return [String]
attr_accessor :customer_demarc_id
# Google-assigned unique ID for this circuit. Assigned at circuit turn-up.
# Corresponds to the JSON property `googleCircuitId`
# @return [String]
attr_accessor :google_circuit_id
# Google-side demarc ID for this circuit. Assigned at circuit turn-up and
# provided by Google to the customer in the LOA.
# Corresponds to the JSON property `googleDemarcId`
# @return [String]
attr_accessor :google_demarc_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@customer_demarc_id = args[:customer_demarc_id] if args.key?(:customer_demarc_id)
@google_circuit_id = args[:google_circuit_id] if args.key?(:google_circuit_id)
@google_demarc_id = args[:google_demarc_id] if args.key?(:google_demarc_id)
end
end
# Diagnostics information about interconnect, contains detailed and current
# technical information about Google's side of the connection.
class InterconnectDiagnostics
include Google::Apis::Core::Hashable
# A list of InterconnectDiagnostics.ARPEntry objects, describing individual
# neighbors currently seen by the Google router in the ARP cache for the
# Interconnect. This will be empty when the Interconnect is not bundled.
# Corresponds to the JSON property `arpCaches`
# @return [Array<Google::Apis::ComputeV1::InterconnectDiagnosticsArpEntry>]
attr_accessor :arp_caches
# A list of InterconnectDiagnostics.LinkStatus objects, describing the status
# for each link on the Interconnect.
# Corresponds to the JSON property `links`
# @return [Array<Google::Apis::ComputeV1::InterconnectDiagnosticsLinkStatus>]
attr_accessor :links
# The MAC address of the Interconnect's bundle interface.
# Corresponds to the JSON property `macAddress`
# @return [String]
attr_accessor :mac_address
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@arp_caches = args[:arp_caches] if args.key?(:arp_caches)
@links = args[:links] if args.key?(:links)
@mac_address = args[:mac_address] if args.key?(:mac_address)
end
end
# Describing the ARP neighbor entries seen on this link
class InterconnectDiagnosticsArpEntry
include Google::Apis::Core::Hashable
# The IP address of this ARP neighbor.
# Corresponds to the JSON property `ipAddress`
# @return [String]
attr_accessor :ip_address
# The MAC address of this ARP neighbor.
# Corresponds to the JSON property `macAddress`
# @return [String]
attr_accessor :mac_address
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@ip_address = args[:ip_address] if args.key?(:ip_address)
@mac_address = args[:mac_address] if args.key?(:mac_address)
end
end
#
class InterconnectDiagnosticsLinkLacpStatus
include Google::Apis::Core::Hashable
# System ID of the port on Google's side of the LACP exchange.
# Corresponds to the JSON property `googleSystemId`
# @return [String]
attr_accessor :google_system_id
# System ID of the port on the neighbor's side of the LACP exchange.
# Corresponds to the JSON property `neighborSystemId`
# @return [String]
attr_accessor :neighbor_system_id
# The state of a LACP link, which can take one of the following values:
# - ACTIVE: The link is configured and active within the bundle.
# - DETACHED: The link is not configured within the bundle. This means that the
# rest of the object should be empty.
# Corresponds to the JSON property `state`
# @return [String]
attr_accessor :state
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@google_system_id = args[:google_system_id] if args.key?(:google_system_id)
@neighbor_system_id = args[:neighbor_system_id] if args.key?(:neighbor_system_id)
@state = args[:state] if args.key?(:state)
end
end
#
class InterconnectDiagnosticsLinkOpticalPower
include Google::Apis::Core::Hashable
# The status of the current value when compared to the warning and alarm levels
# for the receiving or transmitting transceiver. Possible states include:
# - OK: The value has not crossed a warning threshold.
# - LOW_WARNING: The value has crossed below the low warning threshold.
# - HIGH_WARNING: The value has crossed above the high warning threshold.
# - LOW_ALARM: The value has crossed below the low alarm threshold.
# - HIGH_ALARM: The value has crossed above the high alarm threshold.
# Corresponds to the JSON property `state`
# @return [String]
attr_accessor :state
# Value of the current receiving or transmitting optical power, read in dBm.
# Take a known good optical value, give it a 10% margin and trigger warnings
# relative to that value. In general, a -7dBm warning and a -11dBm alarm are
# good optical value estimates for most links.
# Corresponds to the JSON property `value`
# @return [Float]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@state = args[:state] if args.key?(:state)
@value = args[:value] if args.key?(:value)
end
end
#
class InterconnectDiagnosticsLinkStatus
include Google::Apis::Core::Hashable
# A list of InterconnectDiagnostics.ARPEntry objects, describing the ARP
# neighbor entries seen on this link. This will be empty if the link is bundled
# Corresponds to the JSON property `arpCaches`
# @return [Array<Google::Apis::ComputeV1::InterconnectDiagnosticsArpEntry>]
attr_accessor :arp_caches
# The unique ID for this link assigned during turn up by Google.
# Corresponds to the JSON property `circuitId`
# @return [String]
attr_accessor :circuit_id
# The Demarc address assigned by Google and provided in the LoA.
# Corresponds to the JSON property `googleDemarc`
# @return [String]
attr_accessor :google_demarc
#
# Corresponds to the JSON property `lacpStatus`
# @return [Google::Apis::ComputeV1::InterconnectDiagnosticsLinkLacpStatus]
attr_accessor :lacp_status
# An InterconnectDiagnostics.LinkOpticalPower object, describing the current
# value and status of the received light level.
# Corresponds to the JSON property `receivingOpticalPower`
# @return [Google::Apis::ComputeV1::InterconnectDiagnosticsLinkOpticalPower]
attr_accessor :receiving_optical_power
# An InterconnectDiagnostics.LinkOpticalPower object, describing the current
# value and status of the transmitted light level.
# Corresponds to the JSON property `transmittingOpticalPower`
# @return [Google::Apis::ComputeV1::InterconnectDiagnosticsLinkOpticalPower]
attr_accessor :transmitting_optical_power
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@arp_caches = args[:arp_caches] if args.key?(:arp_caches)
@circuit_id = args[:circuit_id] if args.key?(:circuit_id)
@google_demarc = args[:google_demarc] if args.key?(:google_demarc)
@lacp_status = args[:lacp_status] if args.key?(:lacp_status)
@receiving_optical_power = args[:receiving_optical_power] if args.key?(:receiving_optical_power)
@transmitting_optical_power = args[:transmitting_optical_power] if args.key?(:transmitting_optical_power)
end
end
# Response to the list request, and contains a list of interconnects.
class InterconnectList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of Interconnect resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::Interconnect>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#interconnectList for lists of
# interconnects.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::InterconnectList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::InterconnectList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Represents an Interconnect Attachment (VLAN) Location resource.
# You can use this resource to find location details about an Interconnect
# attachment (VLAN). For more information about interconnect attachments, read
# Creating VLAN Attachments.
class InterconnectLocation
include Google::Apis::Core::Hashable
# [Output Only] The postal address of the Point of Presence, each line in the
# address is separated by a newline character.
# Corresponds to the JSON property `address`
# @return [String]
attr_accessor :address
# [Output Only] Availability zone for this InterconnectLocation. Within a
# metropolitan area (metro), maintenance will not be simultaneously scheduled in
# more than one availability zone. Example: "zone1" or "zone2".
# Corresponds to the JSON property `availabilityZone`
# @return [String]
attr_accessor :availability_zone
# [Output Only] Metropolitan area designator that indicates which city an
# interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands".
# Corresponds to the JSON property `city`
# @return [String]
attr_accessor :city
# [Output Only] Continent for this location, which can take one of the following
# values:
# - AFRICA
# - ASIA_PAC
# - EUROPE
# - NORTH_AMERICA
# - SOUTH_AMERICA
# Corresponds to the JSON property `continent`
# @return [String]
attr_accessor :continent
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# [Output Only] An optional description of the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] The name of the provider for this facility (e.g., EQUINIX).
# Corresponds to the JSON property `facilityProvider`
# @return [String]
attr_accessor :facility_provider
# [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-
# DC1).
# Corresponds to the JSON property `facilityProviderFacilityId`
# @return [String]
attr_accessor :facility_provider_facility_id
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] Type of the resource. Always compute#interconnectLocation for
# interconnect locations.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] Name of the resource.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# [Output Only] The peeringdb identifier for this facility (corresponding with a
# netfac type in peeringdb).
# Corresponds to the JSON property `peeringdbFacilityId`
# @return [String]
attr_accessor :peeringdb_facility_id
# [Output Only] A list of InterconnectLocation.RegionInfo objects, that describe
# parameters pertaining to the relation between this InterconnectLocation and
# various Google Cloud regions.
# Corresponds to the JSON property `regionInfos`
# @return [Array<Google::Apis::ComputeV1::InterconnectLocationRegionInfo>]
attr_accessor :region_infos
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] The status of this InterconnectLocation, which can take one of
# the following values:
# - CLOSED: The InterconnectLocation is closed and is unavailable for
# provisioning new Interconnects.
# - AVAILABLE: The InterconnectLocation is available for provisioning new
# Interconnects.
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@address = args[:address] if args.key?(:address)
@availability_zone = args[:availability_zone] if args.key?(:availability_zone)
@city = args[:city] if args.key?(:city)
@continent = args[:continent] if args.key?(:continent)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@facility_provider = args[:facility_provider] if args.key?(:facility_provider)
@facility_provider_facility_id = args[:facility_provider_facility_id] if args.key?(:facility_provider_facility_id)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@peeringdb_facility_id = args[:peeringdb_facility_id] if args.key?(:peeringdb_facility_id)
@region_infos = args[:region_infos] if args.key?(:region_infos)
@self_link = args[:self_link] if args.key?(:self_link)
@status = args[:status] if args.key?(:status)
end
end
# Response to the list request, and contains a list of interconnect locations.
class InterconnectLocationList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of InterconnectLocation resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::InterconnectLocation>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#interconnectLocationList for
# lists of interconnect locations.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::InterconnectLocationList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::InterconnectLocationList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Information about any potential InterconnectAttachments between an
# Interconnect at a specific InterconnectLocation, and a specific Cloud Region.
class InterconnectLocationRegionInfo
include Google::Apis::Core::Hashable
# Expected round-trip time in milliseconds, from this InterconnectLocation to a
# VM in this region.
# Corresponds to the JSON property `expectedRttMs`
# @return [Fixnum]
attr_accessor :expected_rtt_ms
# Identifies the network presence of this location.
# Corresponds to the JSON property `locationPresence`
# @return [String]
attr_accessor :location_presence
# URL for the region of this location.
# Corresponds to the JSON property `region`
# @return [String]
attr_accessor :region
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@expected_rtt_ms = args[:expected_rtt_ms] if args.key?(:expected_rtt_ms)
@location_presence = args[:location_presence] if args.key?(:location_presence)
@region = args[:region] if args.key?(:region)
end
end
# Description of a planned outage on this Interconnect.
class InterconnectOutageNotification
include Google::Apis::Core::Hashable
# If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that
# will be affected.
# Corresponds to the JSON property `affectedCircuits`
# @return [Array<String>]
attr_accessor :affected_circuits
# A description about the purpose of the outage.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Scheduled end time for the outage (milliseconds since Unix epoch).
# Corresponds to the JSON property `endTime`
# @return [Fixnum]
attr_accessor :end_time
# Form this outage is expected to take, which can take one of the following
# values:
# - OUTAGE: The Interconnect may be completely out of service for some or all of
# the specified window.
# - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should
# remain up, but with reduced bandwidth. Note that the versions of this enum
# prefixed with "IT_" have been deprecated in favor of the unprefixed values.
# Corresponds to the JSON property `issueType`
# @return [String]
attr_accessor :issue_type
# Unique identifier for this outage notification.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The party that generated this notification, which can take the following value:
#
# - GOOGLE: this notification as generated by Google. Note that the value of
# NSRC_GOOGLE has been deprecated in favor of GOOGLE.
# Corresponds to the JSON property `source`
# @return [String]
attr_accessor :source
# Scheduled start time for the outage (milliseconds since Unix epoch).
# Corresponds to the JSON property `startTime`
# @return [Fixnum]
attr_accessor :start_time
# State of this notification, which can take one of the following values:
# - ACTIVE: This outage notification is active. The event could be in the past,
# present, or future. See start_time and end_time for scheduling.
# - CANCELLED: The outage associated with this notification was cancelled before
# the outage was due to start. Note that the versions of this enum prefixed with
# "NS_" have been deprecated in favor of the unprefixed values.
# Corresponds to the JSON property `state`
# @return [String]
attr_accessor :state
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@affected_circuits = args[:affected_circuits] if args.key?(:affected_circuits)
@description = args[:description] if args.key?(:description)
@end_time = args[:end_time] if args.key?(:end_time)
@issue_type = args[:issue_type] if args.key?(:issue_type)
@name = args[:name] if args.key?(:name)
@source = args[:source] if args.key?(:source)
@start_time = args[:start_time] if args.key?(:start_time)
@state = args[:state] if args.key?(:state)
end
end
# Response for the InterconnectsGetDiagnosticsRequest.
class InterconnectsGetDiagnosticsResponse
include Google::Apis::Core::Hashable
# Diagnostics information about interconnect, contains detailed and current
# technical information about Google's side of the connection.
# Corresponds to the JSON property `result`
# @return [Google::Apis::ComputeV1::InterconnectDiagnostics]
attr_accessor :result
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@result = args[:result] if args.key?(:result)
end
end
# Represents a License resource.
# A License represents billing and aggregate usage data for public and
# marketplace images. Caution This resource is intended for use only by third-
# party partners who are creating Cloud Marketplace images. (== resource_for `$
# api_version`.licenses ==)
class License
include Google::Apis::Core::Hashable
# [Output Only] Deprecated. This field no longer reflects whether a license
# charges a usage fee.
# Corresponds to the JSON property `chargesUseFee`
# @return [Boolean]
attr_accessor :charges_use_fee
alias_method :charges_use_fee?, :charges_use_fee
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional textual description of the resource; provided by the client when
# the resource is created.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] Type of resource. Always compute#license for licenses.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] The unique code used to attach this license to images, snapshots,
# and disks.
# Corresponds to the JSON property `licenseCode`
# @return [Fixnum]
attr_accessor :license_code
# Name of the resource. The name must be 1-63 characters long and comply with
# RFC1035.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
#
# Corresponds to the JSON property `resourceRequirements`
# @return [Google::Apis::ComputeV1::LicenseResourceRequirements]
attr_accessor :resource_requirements
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# If false, licenses will not be copied from the source resource when creating
# an image from a disk, disk from snapshot, or snapshot from disk.
# Corresponds to the JSON property `transferable`
# @return [Boolean]
attr_accessor :transferable
alias_method :transferable?, :transferable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@charges_use_fee = args[:charges_use_fee] if args.key?(:charges_use_fee)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@license_code = args[:license_code] if args.key?(:license_code)
@name = args[:name] if args.key?(:name)
@resource_requirements = args[:resource_requirements] if args.key?(:resource_requirements)
@self_link = args[:self_link] if args.key?(:self_link)
@transferable = args[:transferable] if args.key?(:transferable)
end
end
# Represents a License Code resource.
# A License Code is a unique identifier used to represent a license resource.
# Caution This resource is intended for use only by third-party partners who are
# creating Cloud Marketplace images. (== resource_for `$api_version`.
# licenseCodes ==)
class LicenseCode
include Google::Apis::Core::Hashable
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# [Output Only] Description of this License Code.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] Type of resource. Always compute#licenseCode for licenses.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] URL and description aliases of Licenses with the same License
# Code.
# Corresponds to the JSON property `licenseAlias`
# @return [Array<Google::Apis::ComputeV1::LicenseCodeLicenseAlias>]
attr_accessor :license_alias
# [Output Only] Name of the resource. The name is 1-20 characters long and must
# be a valid 64 bit integer.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Current state of this License Code.
# Corresponds to the JSON property `state`
# @return [String]
attr_accessor :state
# [Output Only] If true, the license will remain attached when creating images
# or snapshots from disks. Otherwise, the license is not transferred.
# Corresponds to the JSON property `transferable`
# @return [Boolean]
attr_accessor :transferable
alias_method :transferable?, :transferable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@license_alias = args[:license_alias] if args.key?(:license_alias)
@name = args[:name] if args.key?(:name)
@self_link = args[:self_link] if args.key?(:self_link)
@state = args[:state] if args.key?(:state)
@transferable = args[:transferable] if args.key?(:transferable)
end
end
#
class LicenseCodeLicenseAlias
include Google::Apis::Core::Hashable
# [Output Only] Description of this License Code.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] URL of license corresponding to this License Code.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@description = args[:description] if args.key?(:description)
@self_link = args[:self_link] if args.key?(:self_link)
end
end
#
class LicenseResourceRequirements
include Google::Apis::Core::Hashable
# Minimum number of guest cpus required to use the Instance. Enforced at
# Instance creation and Instance start.
# Corresponds to the JSON property `minGuestCpuCount`
# @return [Fixnum]
attr_accessor :min_guest_cpu_count
# Minimum memory required to use the Instance. Enforced at Instance creation and
# Instance start.
# Corresponds to the JSON property `minMemoryMb`
# @return [Fixnum]
attr_accessor :min_memory_mb
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@min_guest_cpu_count = args[:min_guest_cpu_count] if args.key?(:min_guest_cpu_count)
@min_memory_mb = args[:min_memory_mb] if args.key?(:min_memory_mb)
end
end
#
class LicensesListResponse
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of License resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::License>]
attr_accessor :items
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::LicensesListResponse::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::LicensesListResponse::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Specifies what kind of log the caller must write
class LogConfig
include Google::Apis::Core::Hashable
# Write a Cloud Audit log
# Corresponds to the JSON property `cloudAudit`
# @return [Google::Apis::ComputeV1::LogConfigCloudAuditOptions]
attr_accessor :cloud_audit
# Increment a streamz counter with the specified metric and field names.
# Metric names should start with a '/', generally be lowercase-only, and end in "
# _count". Field names should not contain an initial slash. The actual exported
# metric names will have "/iam/policy" prepended.
# Field names correspond to IAM request parameters and field values are their
# respective values.
# Supported field names: - "authority", which is "[token]" if IAMContext.token
# is present, otherwise the value of IAMContext.authority_selector if present,
# and otherwise a representation of IAMContext.principal; or - "iam_principal",
# a representation of IAMContext.principal even if a token or authority selector
# is present; or - "" (empty string), resulting in a counter with no fields.
# Examples: counter ` metric: "/debug_access_count" field: "iam_principal" ` ==>
# increment counter /iam/policy/debug_access_count `iam_principal=[value of
# IAMContext.principal]`
# Corresponds to the JSON property `counter`
# @return [Google::Apis::ComputeV1::LogConfigCounterOptions]
attr_accessor :counter
# Write a Data Access (Gin) log
# Corresponds to the JSON property `dataAccess`
# @return [Google::Apis::ComputeV1::LogConfigDataAccessOptions]
attr_accessor :data_access
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@cloud_audit = args[:cloud_audit] if args.key?(:cloud_audit)
@counter = args[:counter] if args.key?(:counter)
@data_access = args[:data_access] if args.key?(:data_access)
end
end
# Write a Cloud Audit log
class LogConfigCloudAuditOptions
include Google::Apis::Core::Hashable
# Authorization-related information used by Cloud Audit Logging.
# Corresponds to the JSON property `authorizationLoggingOptions`
# @return [Google::Apis::ComputeV1::AuthorizationLoggingOptions]
attr_accessor :authorization_logging_options
# The log_name to populate in the Cloud Audit Record.
# Corresponds to the JSON property `logName`
# @return [String]
attr_accessor :log_name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@authorization_logging_options = args[:authorization_logging_options] if args.key?(:authorization_logging_options)
@log_name = args[:log_name] if args.key?(:log_name)
end
end
# Increment a streamz counter with the specified metric and field names.
# Metric names should start with a '/', generally be lowercase-only, and end in "
# _count". Field names should not contain an initial slash. The actual exported
# metric names will have "/iam/policy" prepended.
# Field names correspond to IAM request parameters and field values are their
# respective values.
# Supported field names: - "authority", which is "[token]" if IAMContext.token
# is present, otherwise the value of IAMContext.authority_selector if present,
# and otherwise a representation of IAMContext.principal; or - "iam_principal",
# a representation of IAMContext.principal even if a token or authority selector
# is present; or - "" (empty string), resulting in a counter with no fields.
# Examples: counter ` metric: "/debug_access_count" field: "iam_principal" ` ==>
# increment counter /iam/policy/debug_access_count `iam_principal=[value of
# IAMContext.principal]`
class LogConfigCounterOptions
include Google::Apis::Core::Hashable
# Custom fields.
# Corresponds to the JSON property `customFields`
# @return [Array<Google::Apis::ComputeV1::LogConfigCounterOptionsCustomField>]
attr_accessor :custom_fields
# The field value to attribute.
# Corresponds to the JSON property `field`
# @return [String]
attr_accessor :field
# The metric to update.
# Corresponds to the JSON property `metric`
# @return [String]
attr_accessor :metric
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@custom_fields = args[:custom_fields] if args.key?(:custom_fields)
@field = args[:field] if args.key?(:field)
@metric = args[:metric] if args.key?(:metric)
end
end
# Custom fields. These can be used to create a counter with arbitrary field/
# value pairs. See: go/rpcsp-custom-fields.
class LogConfigCounterOptionsCustomField
include Google::Apis::Core::Hashable
# Name is the field name.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Value is the field value. It is important that in contrast to the
# CounterOptions.field, the value here is a constant that is not derived from
# the IAMContext.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@name = args[:name] if args.key?(:name)
@value = args[:value] if args.key?(:value)
end
end
# Write a Data Access (Gin) log
class LogConfigDataAccessOptions
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `logMode`
# @return [String]
attr_accessor :log_mode
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@log_mode = args[:log_mode] if args.key?(:log_mode)
end
end
# Represents a Machine Type resource.
# You can use specific machine types for your VM instances based on performance
# and pricing requirements. For more information, read Machine Types. (==
# resource_for `$api_version`.machineTypes ==)
class MachineType
include Google::Apis::Core::Hashable
# [Output Only] A list of accelerator configurations assigned to this machine
# type.
# Corresponds to the JSON property `accelerators`
# @return [Array<Google::Apis::ComputeV1::MachineType::Accelerator>]
attr_accessor :accelerators
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# Deprecation status for a public resource.
# Corresponds to the JSON property `deprecated`
# @return [Google::Apis::ComputeV1::DeprecationStatus]
attr_accessor :deprecated
# [Output Only] An optional textual description of the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] The number of virtual CPUs that are available to the instance.
# Corresponds to the JSON property `guestCpus`
# @return [Fixnum]
attr_accessor :guest_cpus
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Deprecated] This property is deprecated and will never be populated with any
# relevant values.
# Corresponds to the JSON property `imageSpaceGb`
# @return [Fixnum]
attr_accessor :image_space_gb
# [Output Only] Whether this machine type has a shared CPU. See Shared-core
# machine types for more information.
# Corresponds to the JSON property `isSharedCpu`
# @return [Boolean]
attr_accessor :is_shared_cpu
alias_method :is_shared_cpu?, :is_shared_cpu
# [Output Only] The type of the resource. Always compute#machineType for machine
# types.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] Maximum persistent disks allowed.
# Corresponds to the JSON property `maximumPersistentDisks`
# @return [Fixnum]
attr_accessor :maximum_persistent_disks
# [Output Only] Maximum total persistent disks size (GB) allowed.
# Corresponds to the JSON property `maximumPersistentDisksSizeGb`
# @return [Fixnum]
attr_accessor :maximum_persistent_disks_size_gb
# [Output Only] The amount of physical memory available to the instance, defined
# in MB.
# Corresponds to the JSON property `memoryMb`
# @return [Fixnum]
attr_accessor :memory_mb
# [Output Only] Name of the resource.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# [Output Only] A list of extended scratch disks assigned to the instance.
# Corresponds to the JSON property `scratchDisks`
# @return [Array<Google::Apis::ComputeV1::MachineType::ScratchDisk>]
attr_accessor :scratch_disks
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] The name of the zone where the machine type resides, such as us-
# central1-a.
# Corresponds to the JSON property `zone`
# @return [String]
attr_accessor :zone
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@accelerators = args[:accelerators] if args.key?(:accelerators)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@deprecated = args[:deprecated] if args.key?(:deprecated)
@description = args[:description] if args.key?(:description)
@guest_cpus = args[:guest_cpus] if args.key?(:guest_cpus)
@id = args[:id] if args.key?(:id)
@image_space_gb = args[:image_space_gb] if args.key?(:image_space_gb)
@is_shared_cpu = args[:is_shared_cpu] if args.key?(:is_shared_cpu)
@kind = args[:kind] if args.key?(:kind)
@maximum_persistent_disks = args[:maximum_persistent_disks] if args.key?(:maximum_persistent_disks)
@maximum_persistent_disks_size_gb = args[:maximum_persistent_disks_size_gb] if args.key?(:maximum_persistent_disks_size_gb)
@memory_mb = args[:memory_mb] if args.key?(:memory_mb)
@name = args[:name] if args.key?(:name)
@scratch_disks = args[:scratch_disks] if args.key?(:scratch_disks)
@self_link = args[:self_link] if args.key?(:self_link)
@zone = args[:zone] if args.key?(:zone)
end
#
class Accelerator
include Google::Apis::Core::Hashable
# Number of accelerator cards exposed to the guest.
# Corresponds to the JSON property `guestAcceleratorCount`
# @return [Fixnum]
attr_accessor :guest_accelerator_count
# The accelerator type resource name, not a full URL, e.g. 'nvidia-tesla-k80'.
# Corresponds to the JSON property `guestAcceleratorType`
# @return [String]
attr_accessor :guest_accelerator_type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@guest_accelerator_count = args[:guest_accelerator_count] if args.key?(:guest_accelerator_count)
@guest_accelerator_type = args[:guest_accelerator_type] if args.key?(:guest_accelerator_type)
end
end
#
class ScratchDisk
include Google::Apis::Core::Hashable
# Size of the scratch disk, defined in GB.
# Corresponds to the JSON property `diskGb`
# @return [Fixnum]
attr_accessor :disk_gb
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@disk_gb = args[:disk_gb] if args.key?(:disk_gb)
end
end
end
#
class MachineTypeAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of MachineTypesScopedList resources.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::MachineTypesScopedList>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#machineTypeAggregatedList for
# aggregated lists of machine types.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::MachineTypeAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::MachineTypeAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Contains a list of machine types.
class MachineTypeList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of MachineType resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::MachineType>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#machineTypeList for lists of
# machine types.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::MachineTypeList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::MachineTypeList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class MachineTypesScopedList
include Google::Apis::Core::Hashable
# [Output Only] A list of machine types contained in this scope.
# Corresponds to the JSON property `machineTypes`
# @return [Array<Google::Apis::ComputeV1::MachineType>]
attr_accessor :machine_types
# [Output Only] An informational warning that appears when the machine types
# list is empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::MachineTypesScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@machine_types = args[:machine_types] if args.key?(:machine_types)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] An informational warning that appears when the machine types
# list is empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::MachineTypesScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# A Managed Instance resource.
class ManagedInstance
include Google::Apis::Core::Hashable
# [Output Only] The current action that the managed instance group has scheduled
# for the instance. Possible values:
# - NONE The instance is running, and the managed instance group does not have
# any scheduled actions for this instance.
# - CREATING The managed instance group is creating this instance. If the group
# fails to create this instance, it will try again until it is successful.
# - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create
# this instance only once. If the group fails to create this instance, it does
# not try again and the group's targetSize value is decreased instead.
# - RECREATING The managed instance group is recreating this instance.
# - DELETING The managed instance group is permanently deleting this instance.
# - ABANDONING The managed instance group is abandoning this instance. The
# instance will be removed from the instance group and from any target pools
# that are associated with this group.
# - RESTARTING The managed instance group is restarting the instance.
# - REFRESHING The managed instance group is applying configuration changes to
# the instance without stopping it. For example, the group can update the target
# pool list for an instance without stopping that instance.
# - VERIFYING The managed instance group has created the instance and it is in
# the process of being verified.
# Corresponds to the JSON property `currentAction`
# @return [String]
attr_accessor :current_action
# [Output only] The unique identifier for this resource. This field is empty
# when instance does not exist.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] The URL of the instance. The URL can exist even if the instance
# has not yet been created.
# Corresponds to the JSON property `instance`
# @return [String]
attr_accessor :instance
# [Output Only] Health state of the instance per health-check.
# Corresponds to the JSON property `instanceHealth`
# @return [Array<Google::Apis::ComputeV1::ManagedInstanceInstanceHealth>]
attr_accessor :instance_health
# [Output Only] The status of the instance. This field is empty when the
# instance does not exist.
# Corresponds to the JSON property `instanceStatus`
# @return [String]
attr_accessor :instance_status
# [Output Only] Information about the last attempt to create or delete the
# instance.
# Corresponds to the JSON property `lastAttempt`
# @return [Google::Apis::ComputeV1::ManagedInstanceLastAttempt]
attr_accessor :last_attempt
# [Output Only] Intended version of this instance.
# Corresponds to the JSON property `version`
# @return [Google::Apis::ComputeV1::ManagedInstanceVersion]
attr_accessor :version
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@current_action = args[:current_action] if args.key?(:current_action)
@id = args[:id] if args.key?(:id)
@instance = args[:instance] if args.key?(:instance)
@instance_health = args[:instance_health] if args.key?(:instance_health)
@instance_status = args[:instance_status] if args.key?(:instance_status)
@last_attempt = args[:last_attempt] if args.key?(:last_attempt)
@version = args[:version] if args.key?(:version)
end
end
#
class ManagedInstanceInstanceHealth
include Google::Apis::Core::Hashable
# [Output Only] The current detailed instance health state.
# Corresponds to the JSON property `detailedHealthState`
# @return [String]
attr_accessor :detailed_health_state
# [Output Only] The URL for the health check that verifies whether the instance
# is healthy.
# Corresponds to the JSON property `healthCheck`
# @return [String]
attr_accessor :health_check
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@detailed_health_state = args[:detailed_health_state] if args.key?(:detailed_health_state)
@health_check = args[:health_check] if args.key?(:health_check)
end
end
#
class ManagedInstanceLastAttempt
include Google::Apis::Core::Hashable
# [Output Only] Encountered errors during the last attempt to create or delete
# the instance.
# Corresponds to the JSON property `errors`
# @return [Google::Apis::ComputeV1::ManagedInstanceLastAttempt::Errors]
attr_accessor :errors
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@errors = args[:errors] if args.key?(:errors)
end
# [Output Only] Encountered errors during the last attempt to create or delete
# the instance.
class Errors
include Google::Apis::Core::Hashable
# [Output Only] The array of errors encountered while processing this operation.
# Corresponds to the JSON property `errors`
# @return [Array<Google::Apis::ComputeV1::ManagedInstanceLastAttempt::Errors::Error>]
attr_accessor :errors
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@errors = args[:errors] if args.key?(:errors)
end
#
class Error
include Google::Apis::Core::Hashable
# [Output Only] The error type identifier for this error.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Indicates the field in the request that caused the error. This
# property is optional.
# Corresponds to the JSON property `location`
# @return [String]
attr_accessor :location
# [Output Only] An optional, human-readable error message.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@location = args[:location] if args.key?(:location)
@message = args[:message] if args.key?(:message)
end
end
end
end
#
class ManagedInstanceVersion
include Google::Apis::Core::Hashable
# [Output Only] The intended template of the instance. This field is empty when
# current_action is one of ` DELETING, ABANDONING `.
# Corresponds to the JSON property `instanceTemplate`
# @return [String]
attr_accessor :instance_template
# [Output Only] Name of the version.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@instance_template = args[:instance_template] if args.key?(:instance_template)
@name = args[:name] if args.key?(:name)
end
end
# A metadata key/value entry.
class Metadata
include Google::Apis::Core::Hashable
# 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.
# Corresponds to the JSON property `fingerprint`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :fingerprint
# Array of key/value pairs. The total size of all keys and values must be less
# than 512 KB.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::Metadata::Item>]
attr_accessor :items
# [Output Only] Type of the resource. Always compute#metadata for metadata.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@fingerprint = args[:fingerprint] if args.key?(:fingerprint)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
end
#
class Item
include Google::Apis::Core::Hashable
# Key for the metadata entry. Keys must conform to the following regexp: [a-zA-
# Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a
# URL in the metadata server. Additionally, to avoid ambiguity, keys must not
# conflict with any other metadata keys for the project.
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# 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).
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
# Opaque filter criteria used by loadbalancers to restrict routing configuration
# to a limited set of loadbalancing proxies. Proxies and sidecars involved in
# loadbalancing would typically present metadata to the loadbalancers which need
# to match criteria specified here. If a match takes place, the relevant
# 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.
# An example for using metadataFilters would be: if loadbalancing involves
# Envoys, they will only receive routing configuration when values in
# metadataFilters match values supplied in <a href="https://www.envoyproxy.io/
# docs/envoy/latest/api-v2/api/v2/core/base.proto#envoy-api-msg-core-node" Node
# metadata of their XDS requests to loadbalancers.
class MetadataFilter
include Google::Apis::Core::Hashable
# 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.
# Corresponds to the JSON property `filterLabels`
# @return [Array<Google::Apis::ComputeV1::MetadataFilterLabelMatch>]
attr_accessor :filter_labels
# Specifies how individual filterLabel matches within the list of filterLabels
# contribute towards the overall metadataFilter match.
# Supported values are:
# - MATCH_ANY: At least one of the filterLabels must have a matching label in
# the provided metadata.
# - MATCH_ALL: All filterLabels must have matching labels in the provided
# metadata.
# Corresponds to the JSON property `filterMatchCriteria`
# @return [String]
attr_accessor :filter_match_criteria
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@filter_labels = args[:filter_labels] if args.key?(:filter_labels)
@filter_match_criteria = args[:filter_match_criteria] if args.key?(:filter_match_criteria)
end
end
# MetadataFilter label name value pairs that are expected to match corresponding
# labels presented as metadata to the loadbalancer.
class MetadataFilterLabelMatch
include Google::Apis::Core::Hashable
# Name of metadata label.
# The name can have a maximum length of 1024 characters and must be at least 1
# character long.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The value of the label must match the specified value.
# value can have a maximum length of 1024 characters.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@name = args[:name] if args.key?(:name)
@value = args[:value] if args.key?(:value)
end
end
# The named port. For example: .
class NamedPort
include Google::Apis::Core::Hashable
# The name for this named port. The name must be 1-63 characters long, and
# comply with RFC1035.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The port number, which can be a value between 1 and 65535.
# Corresponds to the JSON property `port`
# @return [Fixnum]
attr_accessor :port
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@name = args[:name] if args.key?(:name)
@port = args[:port] if args.key?(:port)
end
end
# Represents a VPC Network resource.
# Networks connect resources to each other and to the internet. For more
# information, read Virtual Private Cloud (VPC) Network. (== resource_for `$
# api_version`.networks ==)
class Network
include Google::Apis::Core::Hashable
# Deprecated in favor of subnet mode networks. The range of internal addresses
# that are legal on this network. This range is a CIDR specification, for
# example: 192.168.0.0/16. Provided by the client when the network is created.
# Corresponds to the JSON property `IPv4Range`
# @return [String]
attr_accessor :i_pv4_range
# When set to true, the VPC network is created in auto mode. When set to false,
# the VPC network is created in custom mode.
# An auto mode VPC network starts with one subnet per region. Each subnet has a
# predetermined range as described in Auto mode VPC network IP ranges.
# For custom mode VPC networks, you can add subnets using the subnetworks insert
# method.
# Corresponds to the JSON property `autoCreateSubnetworks`
# @return [Boolean]
attr_accessor :auto_create_subnetworks
alias_method :auto_create_subnetworks?, :auto_create_subnetworks
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this field when you create
# the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] The gateway address for default routing out of the network,
# selected by GCP.
# Corresponds to the JSON property `gatewayIPv4`
# @return [String]
attr_accessor :gateway_i_pv4
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] Type of the resource. Always compute#network for networks.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# 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])?`. The first character must be a lowercase letter, and all
# following characters (except for the last character) must be a dash, lowercase
# letter, or digit. The last character must be a lowercase letter or digit.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# [Output Only] A list of network peerings for the resource.
# Corresponds to the JSON property `peerings`
# @return [Array<Google::Apis::ComputeV1::NetworkPeering>]
attr_accessor :peerings
# A routing configuration attached to a network resource. The message includes
# the list of routers associated with the network, and a flag indicating the
# type of routing behavior to enforce network-wide.
# Corresponds to the JSON property `routingConfig`
# @return [Google::Apis::ComputeV1::NetworkRoutingConfig]
attr_accessor :routing_config
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Server-defined fully-qualified URLs for all subnetworks in this
# VPC network.
# Corresponds to the JSON property `subnetworks`
# @return [Array<String>]
attr_accessor :subnetworks
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@i_pv4_range = args[:i_pv4_range] if args.key?(:i_pv4_range)
@auto_create_subnetworks = args[:auto_create_subnetworks] if args.key?(:auto_create_subnetworks)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@gateway_i_pv4 = args[:gateway_i_pv4] if args.key?(:gateway_i_pv4)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@peerings = args[:peerings] if args.key?(:peerings)
@routing_config = args[:routing_config] if args.key?(:routing_config)
@self_link = args[:self_link] if args.key?(:self_link)
@subnetworks = args[:subnetworks] if args.key?(:subnetworks)
end
end
# The network endpoint.
class NetworkEndpoint
include Google::Apis::Core::Hashable
# Metadata defined as annotations on the network endpoint.
# Corresponds to the JSON property `annotations`
# @return [Hash<String,String>]
attr_accessor :annotations
# Optional fully qualified domain name of network endpoint. This can only be
# specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT.
# Corresponds to the JSON property `fqdn`
# @return [String]
attr_accessor :fqdn
# The name for a specific VM instance that the IP address belongs to. This is
# required for network endpoints of type GCE_VM_IP_PORT. The instance must be in
# the same zone of network endpoint group.
# The name must be 1-63 characters long, and comply with RFC1035.
# Corresponds to the JSON property `instance`
# @return [String]
attr_accessor :instance
# Optional IPv4 address of network endpoint. The IP address must belong to a VM
# in Compute Engine (either the primary IP or as part of an aliased IP range).
# If the IP address is not specified, then the primary IP address for the VM
# instance in the network that the network endpoint group belongs to will be
# used.
# Corresponds to the JSON property `ipAddress`
# @return [String]
attr_accessor :ip_address
# Optional port number of network endpoint. If not specified and the
# NetworkEndpointGroup.network_endpoint_type is GCE_IP_PORT, the defaultPort for
# the network endpoint group will be used.
# Corresponds to the JSON property `port`
# @return [Fixnum]
attr_accessor :port
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@annotations = args[:annotations] if args.key?(:annotations)
@fqdn = args[:fqdn] if args.key?(:fqdn)
@instance = args[:instance] if args.key?(:instance)
@ip_address = args[:ip_address] if args.key?(:ip_address)
@port = args[:port] if args.key?(:port)
end
end
# Represents a collection of network endpoints.
# A network endpoint group (NEG) defines how a set of endpoints should be
# reached, whether they are reachable, and where they are located. For more
# information about using NEGs, see Setting up internet NEGs or Setting up
# zonal NEGs. (== resource_for `$api_version`.networkEndpointGroups ==) (==
# resource_for `$api_version`.globalNetworkEndpointGroups ==)
class NetworkEndpointGroup
include Google::Apis::Core::Hashable
# Metadata defined as annotations on the network endpoint group.
# Corresponds to the JSON property `annotations`
# @return [Hash<String,String>]
attr_accessor :annotations
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# The default port used if the port number is not specified in the network
# endpoint.
# Corresponds to the JSON property `defaultPort`
# @return [Fixnum]
attr_accessor :default_port
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] Type of the resource. Always compute#networkEndpointGroup for
# network endpoint group.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The URL of the network to which all network endpoints in the NEG belong. Uses "
# default" project network if unspecified.
# Corresponds to the JSON property `network`
# @return [String]
attr_accessor :network
# Type of network endpoints in this network endpoint group.
# Corresponds to the JSON property `networkEndpointType`
# @return [String]
attr_accessor :network_endpoint_type
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output only] Number of network endpoints in the network endpoint group.
# Corresponds to the JSON property `size`
# @return [Fixnum]
attr_accessor :size
# Optional URL of the subnetwork to which all network endpoints in the NEG
# belong.
# Corresponds to the JSON property `subnetwork`
# @return [String]
attr_accessor :subnetwork
# [Output Only] The URL of the zone where the network endpoint group is located.
# Corresponds to the JSON property `zone`
# @return [String]
attr_accessor :zone
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@annotations = args[:annotations] if args.key?(:annotations)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@default_port = args[:default_port] if args.key?(:default_port)
@description = args[:description] if args.key?(:description)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@network = args[:network] if args.key?(:network)
@network_endpoint_type = args[:network_endpoint_type] if args.key?(:network_endpoint_type)
@self_link = args[:self_link] if args.key?(:self_link)
@size = args[:size] if args.key?(:size)
@subnetwork = args[:subnetwork] if args.key?(:subnetwork)
@zone = args[:zone] if args.key?(:zone)
end
end
#
class NetworkEndpointGroupAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of NetworkEndpointGroupsScopedList resources.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::NetworkEndpointGroupsScopedList>]
attr_accessor :items
# [Output Only] The resource type, which is always compute#
# networkEndpointGroupAggregatedList for aggregated lists of network endpoint
# groups.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::NetworkEndpointGroupAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::NetworkEndpointGroupAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class NetworkEndpointGroupList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of NetworkEndpointGroup resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::NetworkEndpointGroup>]
attr_accessor :items
# [Output Only] The resource type, which is always compute#
# networkEndpointGroupList for network endpoint group lists.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::NetworkEndpointGroupList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::NetworkEndpointGroupList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class NetworkEndpointGroupsAttachEndpointsRequest
include Google::Apis::Core::Hashable
# The list of network endpoints to be attached.
# Corresponds to the JSON property `networkEndpoints`
# @return [Array<Google::Apis::ComputeV1::NetworkEndpoint>]
attr_accessor :network_endpoints
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@network_endpoints = args[:network_endpoints] if args.key?(:network_endpoints)
end
end
#
class NetworkEndpointGroupsDetachEndpointsRequest
include Google::Apis::Core::Hashable
# The list of network endpoints to be detached.
# Corresponds to the JSON property `networkEndpoints`
# @return [Array<Google::Apis::ComputeV1::NetworkEndpoint>]
attr_accessor :network_endpoints
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@network_endpoints = args[:network_endpoints] if args.key?(:network_endpoints)
end
end
#
class NetworkEndpointGroupsListEndpointsRequest
include Google::Apis::Core::Hashable
# Optional query parameter for showing the health status of each network
# endpoint. Valid options are SKIP or SHOW. If you don't specify this parameter,
# the health status of network endpoints will not be provided.
# Corresponds to the JSON property `healthStatus`
# @return [String]
attr_accessor :health_status
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@health_status = args[:health_status] if args.key?(:health_status)
end
end
#
class NetworkEndpointGroupsListNetworkEndpoints
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of NetworkEndpointWithHealthStatus resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::NetworkEndpointWithHealthStatus>]
attr_accessor :items
# [Output Only] The resource type, which is always compute#
# networkEndpointGroupsListNetworkEndpoints for the list of network endpoints in
# the specified network endpoint group.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::NetworkEndpointGroupsListNetworkEndpoints::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::NetworkEndpointGroupsListNetworkEndpoints::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class NetworkEndpointGroupsScopedList
include Google::Apis::Core::Hashable
# [Output Only] The list of network endpoint groups that are contained in this
# scope.
# Corresponds to the JSON property `networkEndpointGroups`
# @return [Array<Google::Apis::ComputeV1::NetworkEndpointGroup>]
attr_accessor :network_endpoint_groups
# [Output Only] An informational warning that replaces the list of network
# endpoint groups when the list is empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::NetworkEndpointGroupsScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@network_endpoint_groups = args[:network_endpoint_groups] if args.key?(:network_endpoint_groups)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] An informational warning that replaces the list of network
# endpoint groups when the list is empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::NetworkEndpointGroupsScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class NetworkEndpointWithHealthStatus
include Google::Apis::Core::Hashable
# [Output only] The health status of network endpoint;
# Corresponds to the JSON property `healths`
# @return [Array<Google::Apis::ComputeV1::HealthStatusForNetworkEndpoint>]
attr_accessor :healths
# The network endpoint.
# Corresponds to the JSON property `networkEndpoint`
# @return [Google::Apis::ComputeV1::NetworkEndpoint]
attr_accessor :network_endpoint
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@healths = args[:healths] if args.key?(:healths)
@network_endpoint = args[:network_endpoint] if args.key?(:network_endpoint)
end
end
# A network interface resource attached to an instance.
class NetworkInterface
include Google::Apis::Core::Hashable
# 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.
# Corresponds to the JSON property `accessConfigs`
# @return [Array<Google::Apis::ComputeV1::AccessConfig>]
attr_accessor :access_configs
# An array of alias IP ranges for this network interface. You can only specify
# this field for network interfaces in VPC networks.
# Corresponds to the JSON property `aliasIpRanges`
# @return [Array<Google::Apis::ComputeV1::AliasIpRange>]
attr_accessor :alias_ip_ranges
# 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.
# Corresponds to the JSON property `fingerprint`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :fingerprint
# [Output Only] An IPv6 internal network address for this network interface.
# Corresponds to the JSON property `ipv6Address`
# @return [String]
attr_accessor :ipv6_address
# [Output Only] Type of the resource. Always compute#networkInterface for
# network interfaces.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] The name of the network interface, which is generated by the
# server. For network devices, these are eth0, eth1, etc.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# 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
# Corresponds to the JSON property `network`
# @return [String]
attr_accessor :network
# 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.
# Corresponds to the JSON property `networkIP`
# @return [String]
attr_accessor :network_ip
# 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.com/compute/v1/projects/project/regions/region/
# subnetworks/subnetwork
# - regions/region/subnetworks/subnetwork
# Corresponds to the JSON property `subnetwork`
# @return [String]
attr_accessor :subnetwork
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@access_configs = args[:access_configs] if args.key?(:access_configs)
@alias_ip_ranges = args[:alias_ip_ranges] if args.key?(:alias_ip_ranges)
@fingerprint = args[:fingerprint] if args.key?(:fingerprint)
@ipv6_address = args[:ipv6_address] if args.key?(:ipv6_address)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@network = args[:network] if args.key?(:network)
@network_ip = args[:network_ip] if args.key?(:network_ip)
@subnetwork = args[:subnetwork] if args.key?(:subnetwork)
end
end
# Contains a list of networks.
class NetworkList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of Network resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::Network>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#networkList for lists of
# networks.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::NetworkList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::NetworkList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# A network peering attached to a network resource. The message includes the
# peering name, peer network, peering state, and a flag indicating whether
# Google Compute Engine should automatically create routes for the peering.
class NetworkPeering
include Google::Apis::Core::Hashable
# This field will be deprecated soon. Use the exchange_subnet_routes field
# instead. Indicates whether full mesh connectivity is created and managed
# automatically between peered networks. Currently this field should always be
# true since Google Compute Engine will automatically create and manage
# subnetwork routes between two networks when peering state is ACTIVE.
# Corresponds to the JSON property `autoCreateRoutes`
# @return [Boolean]
attr_accessor :auto_create_routes
alias_method :auto_create_routes?, :auto_create_routes
# Indicates whether full mesh connectivity is created and managed automatically
# between peered networks. Currently this field should always be true since
# Google Compute Engine will automatically create and manage subnetwork routes
# between two networks when peering state is ACTIVE.
# Corresponds to the JSON property `exchangeSubnetRoutes`
# @return [Boolean]
attr_accessor :exchange_subnet_routes
alias_method :exchange_subnet_routes?, :exchange_subnet_routes
# Whether to export the custom routes to peer network.
# Corresponds to the JSON property `exportCustomRoutes`
# @return [Boolean]
attr_accessor :export_custom_routes
alias_method :export_custom_routes?, :export_custom_routes
# Whether subnet routes with public IP range are exported. The default value is
# true, all subnet routes are exported. The IPv4 special-use ranges (https://en.
# wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and
# are not controlled by this field.
# Corresponds to the JSON property `exportSubnetRoutesWithPublicIp`
# @return [Boolean]
attr_accessor :export_subnet_routes_with_public_ip
alias_method :export_subnet_routes_with_public_ip?, :export_subnet_routes_with_public_ip
# Whether to import the custom routes from peer network.
# Corresponds to the JSON property `importCustomRoutes`
# @return [Boolean]
attr_accessor :import_custom_routes
alias_method :import_custom_routes?, :import_custom_routes
# Whether subnet routes with public IP range are imported. The default value is
# false. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#
# Special_addresses) are always imported from peers and are not controlled by
# this field.
# Corresponds to the JSON property `importSubnetRoutesWithPublicIp`
# @return [Boolean]
attr_accessor :import_subnet_routes_with_public_ip
alias_method :import_subnet_routes_with_public_ip?, :import_subnet_routes_with_public_ip
# Name of this peering. Provided by the client when the peering is created. The
# name must comply with RFC1035. Specifically, the name must be 1-63 characters
# long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first
# character must be a lowercase letter, and all the following characters must be
# a dash, lowercase letter, or digit, except the last character, which cannot be
# a dash.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The URL of the peer network. It can be either full URL or partial URL. The
# peer network may belong to a different project. If the partial URL does not
# contain project, it is assumed that the peer network is in the same project as
# the current network.
# Corresponds to the JSON property `network`
# @return [String]
attr_accessor :network
# [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The
# peering is `ACTIVE` when there's a matching configuration in the peer network.
# Corresponds to the JSON property `state`
# @return [String]
attr_accessor :state
# [Output Only] Details about the current state of the peering.
# Corresponds to the JSON property `stateDetails`
# @return [String]
attr_accessor :state_details
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@auto_create_routes = args[:auto_create_routes] if args.key?(:auto_create_routes)
@exchange_subnet_routes = args[:exchange_subnet_routes] if args.key?(:exchange_subnet_routes)
@export_custom_routes = args[:export_custom_routes] if args.key?(:export_custom_routes)
@export_subnet_routes_with_public_ip = args[:export_subnet_routes_with_public_ip] if args.key?(:export_subnet_routes_with_public_ip)
@import_custom_routes = args[:import_custom_routes] if args.key?(:import_custom_routes)
@import_subnet_routes_with_public_ip = args[:import_subnet_routes_with_public_ip] if args.key?(:import_subnet_routes_with_public_ip)
@name = args[:name] if args.key?(:name)
@network = args[:network] if args.key?(:network)
@state = args[:state] if args.key?(:state)
@state_details = args[:state_details] if args.key?(:state_details)
end
end
# A routing configuration attached to a network resource. The message includes
# the list of routers associated with the network, and a flag indicating the
# type of routing behavior to enforce network-wide.
class NetworkRoutingConfig
include Google::Apis::Core::Hashable
# The network-wide routing mode to use. If set to REGIONAL, this network's Cloud
# Routers will only advertise routes with subnets of this network in the same
# region as the router. If set to GLOBAL, this network's Cloud Routers will
# advertise routes with all subnets of this network, across regions.
# Corresponds to the JSON property `routingMode`
# @return [String]
attr_accessor :routing_mode
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@routing_mode = args[:routing_mode] if args.key?(:routing_mode)
end
end
#
class NetworksAddPeeringRequest
include Google::Apis::Core::Hashable
# This field will be deprecated soon. Use exchange_subnet_routes in
# network_peering instead. Indicates whether full mesh connectivity is created
# and managed automatically between peered networks. Currently this field should
# always be true since Google Compute Engine will automatically create and
# manage subnetwork routes between two networks when peering state is ACTIVE.
# Corresponds to the JSON property `autoCreateRoutes`
# @return [Boolean]
attr_accessor :auto_create_routes
alias_method :auto_create_routes?, :auto_create_routes
# Name of the peering, which should conform to RFC1035.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# A network peering attached to a network resource. The message includes the
# peering name, peer network, peering state, and a flag indicating whether
# Google Compute Engine should automatically create routes for the peering.
# Corresponds to the JSON property `networkPeering`
# @return [Google::Apis::ComputeV1::NetworkPeering]
attr_accessor :network_peering
# URL of the peer network. It can be either full URL or partial URL. The peer
# network may belong to a different project. If the partial URL does not contain
# project, it is assumed that the peer network is in the same project as the
# current network.
# Corresponds to the JSON property `peerNetwork`
# @return [String]
attr_accessor :peer_network
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@auto_create_routes = args[:auto_create_routes] if args.key?(:auto_create_routes)
@name = args[:name] if args.key?(:name)
@network_peering = args[:network_peering] if args.key?(:network_peering)
@peer_network = args[:peer_network] if args.key?(:peer_network)
end
end
#
class NetworksRemovePeeringRequest
include Google::Apis::Core::Hashable
# Name of the peering, which should conform to RFC1035.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@name = args[:name] if args.key?(:name)
end
end
#
class NetworksUpdatePeeringRequest
include Google::Apis::Core::Hashable
# A network peering attached to a network resource. The message includes the
# peering name, peer network, peering state, and a flag indicating whether
# Google Compute Engine should automatically create routes for the peering.
# Corresponds to the JSON property `networkPeering`
# @return [Google::Apis::ComputeV1::NetworkPeering]
attr_accessor :network_peering
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@network_peering = args[:network_peering] if args.key?(:network_peering)
end
end
# Represent a sole-tenant Node Group resource.
# A sole-tenant node is a physical server that is dedicated to hosting VM
# instances only for your specific project. Use sole-tenant nodes to keep your
# instances physically separated from instances in other projects, or to group
# your instances together on the same host hardware. For more information, read
# Sole-tenant nodes. (== resource_for `$api_version`.nodeGroups ==)
class NodeGroup
include Google::Apis::Core::Hashable
# Specifies how autoscaling should behave.
# Corresponds to the JSON property `autoscalingPolicy`
# @return [Google::Apis::ComputeV1::NodeGroupAutoscalingPolicy]
attr_accessor :autoscaling_policy
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
#
# Corresponds to the JSON property `fingerprint`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :fingerprint
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] The type of the resource. Always compute#nodeGroup for node
# group.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Specifies how to handle instances when a node in the group undergoes
# maintenance.
# Corresponds to the JSON property `maintenancePolicy`
# @return [String]
attr_accessor :maintenance_policy
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# URL of the node template to create the node group from.
# Corresponds to the JSON property `nodeTemplate`
# @return [String]
attr_accessor :node_template
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] The total number of nodes in the node group.
# Corresponds to the JSON property `size`
# @return [Fixnum]
attr_accessor :size
#
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
# [Output Only] The name of the zone where the node group resides, such as us-
# central1-a.
# Corresponds to the JSON property `zone`
# @return [String]
attr_accessor :zone
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@autoscaling_policy = args[:autoscaling_policy] if args.key?(:autoscaling_policy)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@fingerprint = args[:fingerprint] if args.key?(:fingerprint)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@maintenance_policy = args[:maintenance_policy] if args.key?(:maintenance_policy)
@name = args[:name] if args.key?(:name)
@node_template = args[:node_template] if args.key?(:node_template)
@self_link = args[:self_link] if args.key?(:self_link)
@size = args[:size] if args.key?(:size)
@status = args[:status] if args.key?(:status)
@zone = args[:zone] if args.key?(:zone)
end
end
#
class NodeGroupAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of NodeGroupsScopedList resources.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::NodeGroupsScopedList>]
attr_accessor :items
# [Output Only] Type of resource.Always compute#nodeGroupAggregatedList for
# aggregated lists of node groups.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::NodeGroupAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::NodeGroupAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class NodeGroupAutoscalingPolicy
include Google::Apis::Core::Hashable
# The maximum number of nodes that the group should have.
# Corresponds to the JSON property `maxNodes`
# @return [Fixnum]
attr_accessor :max_nodes
# The minimum number of nodes that the group should have.
# Corresponds to the JSON property `minNodes`
# @return [Fixnum]
attr_accessor :min_nodes
# The autoscaling mode.
# Corresponds to the JSON property `mode`
# @return [String]
attr_accessor :mode
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@max_nodes = args[:max_nodes] if args.key?(:max_nodes)
@min_nodes = args[:min_nodes] if args.key?(:min_nodes)
@mode = args[:mode] if args.key?(:mode)
end
end
# Contains a list of nodeGroups.
class NodeGroupList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of NodeGroup resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::NodeGroup>]
attr_accessor :items
# [Output Only] Type of resource.Always compute#nodeGroupList for lists of node
# groups.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::NodeGroupList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::NodeGroupList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class NodeGroupNode
include Google::Apis::Core::Hashable
# Instances scheduled on this node.
# Corresponds to the JSON property `instances`
# @return [Array<String>]
attr_accessor :instances
# The name of the node.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The type of this node.
# Corresponds to the JSON property `nodeType`
# @return [String]
attr_accessor :node_type
# Binding properties for the physical server.
# Corresponds to the JSON property `serverBinding`
# @return [Google::Apis::ComputeV1::ServerBinding]
attr_accessor :server_binding
# Server ID associated with this node.
# Corresponds to the JSON property `serverId`
# @return [String]
attr_accessor :server_id
#
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@instances = args[:instances] if args.key?(:instances)
@name = args[:name] if args.key?(:name)
@node_type = args[:node_type] if args.key?(:node_type)
@server_binding = args[:server_binding] if args.key?(:server_binding)
@server_id = args[:server_id] if args.key?(:server_id)
@status = args[:status] if args.key?(:status)
end
end
#
class NodeGroupsAddNodesRequest
include Google::Apis::Core::Hashable
# Count of additional nodes to be added to the node group.
# Corresponds to the JSON property `additionalNodeCount`
# @return [Fixnum]
attr_accessor :additional_node_count
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@additional_node_count = args[:additional_node_count] if args.key?(:additional_node_count)
end
end
#
class NodeGroupsDeleteNodesRequest
include Google::Apis::Core::Hashable
# Names of the nodes to delete.
# Corresponds to the JSON property `nodes`
# @return [Array<String>]
attr_accessor :nodes
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@nodes = args[:nodes] if args.key?(:nodes)
end
end
#
class NodeGroupsListNodes
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of Node resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::NodeGroupNode>]
attr_accessor :items
# [Output Only] The resource type, which is always compute.nodeGroupsListNodes
# for the list of nodes in the specified node group.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::NodeGroupsListNodes::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::NodeGroupsListNodes::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class NodeGroupsScopedList
include Google::Apis::Core::Hashable
# [Output Only] A list of node groups contained in this scope.
# Corresponds to the JSON property `nodeGroups`
# @return [Array<Google::Apis::ComputeV1::NodeGroup>]
attr_accessor :node_groups
# [Output Only] An informational warning that appears when the nodeGroup list is
# empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::NodeGroupsScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@node_groups = args[:node_groups] if args.key?(:node_groups)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] An informational warning that appears when the nodeGroup list is
# empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::NodeGroupsScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class NodeGroupsSetNodeTemplateRequest
include Google::Apis::Core::Hashable
# Full or partial URL of the node template resource to be updated for this node
# group.
# Corresponds to the JSON property `nodeTemplate`
# @return [String]
attr_accessor :node_template
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@node_template = args[:node_template] if args.key?(:node_template)
end
end
# Represent a sole-tenant Node Template resource.
# You can use a template to define properties for nodes in a node group. For
# more information, read Creating node groups and instances. (== resource_for `$
# api_version`.nodeTemplates ==)
class NodeTemplate
include Google::Apis::Core::Hashable
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] The type of the resource. Always compute#nodeTemplate for node
# templates.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Labels to use for node affinity, which will be used in instance scheduling.
# Corresponds to the JSON property `nodeAffinityLabels`
# @return [Hash<String,String>]
attr_accessor :node_affinity_labels
# The node type to use for nodes group that are created from this template.
# Corresponds to the JSON property `nodeType`
# @return [String]
attr_accessor :node_type
# The flexible properties of the desired node type. Node groups that use this
# node template will create nodes of a type that matches these properties.
# This field is mutually exclusive with the node_type property; you can only
# define one or the other, but not both.
# Corresponds to the JSON property `nodeTypeFlexibility`
# @return [Google::Apis::ComputeV1::NodeTemplateNodeTypeFlexibility]
attr_accessor :node_type_flexibility
# [Output Only] The name of the region where the node template resides, such as
# us-central1.
# Corresponds to the JSON property `region`
# @return [String]
attr_accessor :region
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# Sets the binding properties for the physical server. Valid values include:
# - [Default] RESTART_NODE_ON_ANY_SERVER: Restarts VMs on any available physical
# server
# - RESTART_NODE_ON_MINIMAL_SERVER: Restarts VMs on the same physical server
# whenever possible
# See Sole-tenant node options for more information.
# Corresponds to the JSON property `serverBinding`
# @return [Google::Apis::ComputeV1::ServerBinding]
attr_accessor :server_binding
# [Output Only] The status of the node template. One of the following values:
# CREATING, READY, and DELETING.
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
# [Output Only] An optional, human-readable explanation of the status.
# Corresponds to the JSON property `statusMessage`
# @return [String]
attr_accessor :status_message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@node_affinity_labels = args[:node_affinity_labels] if args.key?(:node_affinity_labels)
@node_type = args[:node_type] if args.key?(:node_type)
@node_type_flexibility = args[:node_type_flexibility] if args.key?(:node_type_flexibility)
@region = args[:region] if args.key?(:region)
@self_link = args[:self_link] if args.key?(:self_link)
@server_binding = args[:server_binding] if args.key?(:server_binding)
@status = args[:status] if args.key?(:status)
@status_message = args[:status_message] if args.key?(:status_message)
end
end
#
class NodeTemplateAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of NodeTemplatesScopedList resources.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::NodeTemplatesScopedList>]
attr_accessor :items
# [Output Only] Type of resource.Always compute#nodeTemplateAggregatedList for
# aggregated lists of node templates.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::NodeTemplateAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::NodeTemplateAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Contains a list of node templates.
class NodeTemplateList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of NodeTemplate resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::NodeTemplate>]
attr_accessor :items
# [Output Only] Type of resource.Always compute#nodeTemplateList for lists of
# node templates.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::NodeTemplateList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::NodeTemplateList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class NodeTemplateNodeTypeFlexibility
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `cpus`
# @return [String]
attr_accessor :cpus
#
# Corresponds to the JSON property `localSsd`
# @return [String]
attr_accessor :local_ssd
#
# Corresponds to the JSON property `memory`
# @return [String]
attr_accessor :memory
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@cpus = args[:cpus] if args.key?(:cpus)
@local_ssd = args[:local_ssd] if args.key?(:local_ssd)
@memory = args[:memory] if args.key?(:memory)
end
end
#
class NodeTemplatesScopedList
include Google::Apis::Core::Hashable
# [Output Only] A list of node templates contained in this scope.
# Corresponds to the JSON property `nodeTemplates`
# @return [Array<Google::Apis::ComputeV1::NodeTemplate>]
attr_accessor :node_templates
# [Output Only] An informational warning that appears when the node templates
# list is empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::NodeTemplatesScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@node_templates = args[:node_templates] if args.key?(:node_templates)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] An informational warning that appears when the node templates
# list is empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::NodeTemplatesScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Represent a sole-tenant Node Type resource.
# Each node within a node group must have a node type. A node type specifies the
# total amount of cores and memory for that node. Currently, the only available
# node type is n1-node-96-624 node type that has 96 vCPUs and 624 GB of memory,
# available in multiple zones. For more information read Node types. (==
# resource_for `$api_version`.nodeTypes ==)
class NodeType
include Google::Apis::Core::Hashable
# [Output Only] The CPU platform used by this node type.
# Corresponds to the JSON property `cpuPlatform`
# @return [String]
attr_accessor :cpu_platform
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# Deprecation status for a public resource.
# Corresponds to the JSON property `deprecated`
# @return [Google::Apis::ComputeV1::DeprecationStatus]
attr_accessor :deprecated
# [Output Only] An optional textual description of the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] The number of virtual CPUs that are available to the node type.
# Corresponds to the JSON property `guestCpus`
# @return [Fixnum]
attr_accessor :guest_cpus
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] The type of the resource. Always compute#nodeType for node types.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] Local SSD available to the node type, defined in GB.
# Corresponds to the JSON property `localSsdGb`
# @return [Fixnum]
attr_accessor :local_ssd_gb
# [Output Only] The amount of physical memory available to the node type,
# defined in MB.
# Corresponds to the JSON property `memoryMb`
# @return [Fixnum]
attr_accessor :memory_mb
# [Output Only] Name of the resource.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] The name of the zone where the node type resides, such as us-
# central1-a.
# Corresponds to the JSON property `zone`
# @return [String]
attr_accessor :zone
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@cpu_platform = args[:cpu_platform] if args.key?(:cpu_platform)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@deprecated = args[:deprecated] if args.key?(:deprecated)
@description = args[:description] if args.key?(:description)
@guest_cpus = args[:guest_cpus] if args.key?(:guest_cpus)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@local_ssd_gb = args[:local_ssd_gb] if args.key?(:local_ssd_gb)
@memory_mb = args[:memory_mb] if args.key?(:memory_mb)
@name = args[:name] if args.key?(:name)
@self_link = args[:self_link] if args.key?(:self_link)
@zone = args[:zone] if args.key?(:zone)
end
end
#
class NodeTypeAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of NodeTypesScopedList resources.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::NodeTypesScopedList>]
attr_accessor :items
# [Output Only] Type of resource.Always compute#nodeTypeAggregatedList for
# aggregated lists of node types.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::NodeTypeAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::NodeTypeAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Contains a list of node types.
class NodeTypeList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of NodeType resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::NodeType>]
attr_accessor :items
# [Output Only] Type of resource.Always compute#nodeTypeList for lists of node
# types.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::NodeTypeList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::NodeTypeList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class NodeTypesScopedList
include Google::Apis::Core::Hashable
# [Output Only] A list of node types contained in this scope.
# Corresponds to the JSON property `nodeTypes`
# @return [Array<Google::Apis::ComputeV1::NodeType>]
attr_accessor :node_types
# [Output Only] An informational warning that appears when the node types list
# is empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::NodeTypesScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@node_types = args[:node_types] if args.key?(:node_types)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] An informational warning that appears when the node types list
# is empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::NodeTypesScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Represents a notification endpoint.
# A notification endpoint resource defines an endpoint to receive notifications
# when there are status changes detected by the associated health check service.
# For more information, see Health checks overview. (== resource_for `$
# api_version`.notificationEndpoint ==) (== resource_for `$api_version`.
# regionNotificationEndpoints ==)
class NotificationEndpoint
include Google::Apis::Core::Hashable
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Represents a gRPC setting that describes one gRPC notification endpoint and
# the retry duration attempting to send notification to this endpoint.
# Corresponds to the JSON property `grpcSettings`
# @return [Google::Apis::ComputeV1::NotificationEndpointGrpcSettings]
attr_accessor :grpc_settings
# [Output Only] A unique identifier for this resource type. The server generates
# this identifier.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] Type of the resource. Always compute#notificationEndpoint for
# notification endpoints.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# [Output Only] URL of the region where the notification endpoint resides. This
# field applies only to the regional resource. You must specify this field as
# part of the HTTP request URL. It is not settable as a field in the request
# body.
# Corresponds to the JSON property `region`
# @return [String]
attr_accessor :region
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@grpc_settings = args[:grpc_settings] if args.key?(:grpc_settings)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@region = args[:region] if args.key?(:region)
@self_link = args[:self_link] if args.key?(:self_link)
end
end
# Represents a gRPC setting that describes one gRPC notification endpoint and
# the retry duration attempting to send notification to this endpoint.
class NotificationEndpointGrpcSettings
include Google::Apis::Core::Hashable
# Optional. If specified, this field is used to set the authority header by the
# sender of notifications. See https://tools.ietf.org/html/rfc7540#section-8.1.2.
# 3
# Corresponds to the JSON property `authority`
# @return [String]
attr_accessor :authority
# Endpoint to which gRPC notifications are sent. This must be a valid gRPCLB DNS
# name.
# Corresponds to the JSON property `endpoint`
# @return [String]
attr_accessor :endpoint
# Optional. If specified, this field is used to populate the "name" field in
# gRPC requests.
# Corresponds to the JSON property `payloadName`
# @return [String]
attr_accessor :payload_name
# A Duration represents a fixed-length span of time represented as a count of
# seconds and fractions of seconds at nanosecond resolution. It is independent
# of any calendar and concepts like "day" or "month". Range is approximately 10,
# 000 years.
# Corresponds to the JSON property `resendInterval`
# @return [Google::Apis::ComputeV1::Duration]
attr_accessor :resend_interval
# How much time (in seconds) is spent attempting notification retries until a
# successful response is received. Default is 30s. Limit is 20m (1200s). Must be
# a positive number.
# Corresponds to the JSON property `retryDurationSec`
# @return [Fixnum]
attr_accessor :retry_duration_sec
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@authority = args[:authority] if args.key?(:authority)
@endpoint = args[:endpoint] if args.key?(:endpoint)
@payload_name = args[:payload_name] if args.key?(:payload_name)
@resend_interval = args[:resend_interval] if args.key?(:resend_interval)
@retry_duration_sec = args[:retry_duration_sec] if args.key?(:retry_duration_sec)
end
end
#
class NotificationEndpointList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of NotificationEndpoint resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::NotificationEndpoint>]
attr_accessor :items
# [Output Only] Type of the resource. Always compute#notificationEndpoint for
# notification endpoints.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::NotificationEndpointList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::NotificationEndpointList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Represents an Operation resource.
# Google Compute Engine has three Operation resources:
# * [Global](/compute/docs/reference/rest/`$api_version`/globalOperations) * [
# Regional](/compute/docs/reference/rest/`$api_version`/regionOperations) * [
# Zonal](/compute/docs/reference/rest/`$api_version`/zoneOperations)
# You can use an operation resource to manage asynchronous API requests. For
# more information, read Handling API responses.
# Operations can be global, regional or zonal.
# - For global operations, use the `globalOperations` resource.
# - For regional operations, use the `regionOperations` resource.
# - For zonal operations, use the `zonalOperations` resource.
# For more information, read Global, Regional, and Zonal Resources. (==
# resource_for `$api_version`.globalOperations ==) (== resource_for `$
# api_version`.regionOperations ==) (== resource_for `$api_version`.
# zoneOperations ==)
class Operation
include Google::Apis::Core::Hashable
# [Output Only] The value of `requestId` if you provided it in the request. Not
# present otherwise.
# Corresponds to the JSON property `clientOperationId`
# @return [String]
attr_accessor :client_operation_id
# [Deprecated] This field is deprecated.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# [Output Only] A textual description of the operation, which is set when the
# operation is created.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] The time that this operation was completed. This value is in
# RFC3339 text format.
# Corresponds to the JSON property `endTime`
# @return [String]
attr_accessor :end_time
# [Output Only] If errors are generated during processing of the operation, this
# field will be populated.
# Corresponds to the JSON property `error`
# @return [Google::Apis::ComputeV1::Operation::Error]
attr_accessor :error
# [Output Only] If the operation fails, this field contains the HTTP error
# message that was returned, such as `NOT FOUND`.
# Corresponds to the JSON property `httpErrorMessage`
# @return [String]
attr_accessor :http_error_message
# [Output Only] If the operation fails, this field contains the HTTP error
# status code that was returned. For example, a `404` means the resource was not
# found.
# Corresponds to the JSON property `httpErrorStatusCode`
# @return [Fixnum]
attr_accessor :http_error_status_code
# [Output Only] The unique identifier for the operation. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] The time that this operation was requested. This value is in
# RFC3339 text format.
# Corresponds to the JSON property `insertTime`
# @return [String]
attr_accessor :insert_time
# [Output Only] Type of the resource. Always `compute#operation` for Operation
# resources.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] Name of the operation.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# [Output Only] The type of operation, such as `insert`, `update`, or `delete`,
# and so on.
# Corresponds to the JSON property `operationType`
# @return [String]
attr_accessor :operation_type
# [Output Only] An optional progress indicator that ranges from 0 to 100. There
# is no requirement that this be linear or support any granularity of operations.
# This should not be used to guess when the operation will be complete. This
# number should monotonically increase as the operation progresses.
# Corresponds to the JSON property `progress`
# @return [Fixnum]
attr_accessor :progress
# [Output Only] The URL of the region where the operation resides. Only
# applicable when performing regional operations.
# Corresponds to the JSON property `region`
# @return [String]
attr_accessor :region
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] The time that this operation was started by the server. This
# value is in RFC3339 text format.
# Corresponds to the JSON property `startTime`
# @return [String]
attr_accessor :start_time
# [Output Only] The status of the operation, which can be one of the following: `
# PENDING`, `RUNNING`, or `DONE`.
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
# [Output Only] An optional textual description of the current status of the
# operation.
# Corresponds to the JSON property `statusMessage`
# @return [String]
attr_accessor :status_message
# [Output Only] The unique target ID, which identifies a specific incarnation of
# the target resource.
# Corresponds to the JSON property `targetId`
# @return [Fixnum]
attr_accessor :target_id
# [Output Only] The URL of the resource that the operation modifies. For
# operations related to creating a snapshot, this points to the persistent disk
# that the snapshot was created from.
# Corresponds to the JSON property `targetLink`
# @return [String]
attr_accessor :target_link
# [Output Only] User who requested the operation, for example: `user@example.com`
# .
# Corresponds to the JSON property `user`
# @return [String]
attr_accessor :user
# [Output Only] If warning messages are generated during processing of the
# operation, this field will be populated.
# Corresponds to the JSON property `warnings`
# @return [Array<Google::Apis::ComputeV1::Operation::Warning>]
attr_accessor :warnings
# [Output Only] The URL of the zone where the operation resides. Only applicable
# when performing per-zone operations.
# Corresponds to the JSON property `zone`
# @return [String]
attr_accessor :zone
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@client_operation_id = args[:client_operation_id] if args.key?(:client_operation_id)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@end_time = args[:end_time] if args.key?(:end_time)
@error = args[:error] if args.key?(:error)
@http_error_message = args[:http_error_message] if args.key?(:http_error_message)
@http_error_status_code = args[:http_error_status_code] if args.key?(:http_error_status_code)
@id = args[:id] if args.key?(:id)
@insert_time = args[:insert_time] if args.key?(:insert_time)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@operation_type = args[:operation_type] if args.key?(:operation_type)
@progress = args[:progress] if args.key?(:progress)
@region = args[:region] if args.key?(:region)
@self_link = args[:self_link] if args.key?(:self_link)
@start_time = args[:start_time] if args.key?(:start_time)
@status = args[:status] if args.key?(:status)
@status_message = args[:status_message] if args.key?(:status_message)
@target_id = args[:target_id] if args.key?(:target_id)
@target_link = args[:target_link] if args.key?(:target_link)
@user = args[:user] if args.key?(:user)
@warnings = args[:warnings] if args.key?(:warnings)
@zone = args[:zone] if args.key?(:zone)
end
# [Output Only] If errors are generated during processing of the operation, this
# field will be populated.
class Error
include Google::Apis::Core::Hashable
# [Output Only] The array of errors encountered while processing this operation.
# Corresponds to the JSON property `errors`
# @return [Array<Google::Apis::ComputeV1::Operation::Error::Error>]
attr_accessor :errors
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@errors = args[:errors] if args.key?(:errors)
end
#
class Error
include Google::Apis::Core::Hashable
# [Output Only] The error type identifier for this error.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Indicates the field in the request that caused the error. This
# property is optional.
# Corresponds to the JSON property `location`
# @return [String]
attr_accessor :location
# [Output Only] An optional, human-readable error message.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@location = args[:location] if args.key?(:location)
@message = args[:message] if args.key?(:message)
end
end
end
#
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::Operation::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class OperationAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# [Output Only] A map of scoped operation lists.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::OperationsScopedList>]
attr_accessor :items
# [Output Only] Type of resource. Always `compute#operationAggregatedList` for
# aggregated lists of operations.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than `maxResults`, use the `
# nextPageToken` as a value for the query parameter `pageToken` in the next list
# request. Subsequent list requests will have their own `nextPageToken` to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::OperationAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::OperationAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Contains a list of Operation resources.
class OperationList
include Google::Apis::Core::Hashable
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# [Output Only] A list of Operation resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::Operation>]
attr_accessor :items
# [Output Only] Type of resource. Always `compute#operations` for Operations
# resource.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than `maxResults`, use the `
# nextPageToken` as a value for the query parameter `pageToken` in the next list
# request. Subsequent list requests will have their own `nextPageToken` to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::OperationList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::OperationList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class OperationsScopedList
include Google::Apis::Core::Hashable
# [Output Only] A list of operations contained in this scope.
# Corresponds to the JSON property `operations`
# @return [Array<Google::Apis::ComputeV1::Operation>]
attr_accessor :operations
# [Output Only] Informational warning which replaces the list of operations when
# the list is empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::OperationsScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@operations = args[:operations] if args.key?(:operations)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning which replaces the list of operations when
# the list is empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::OperationsScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Settings controlling the eviction of unhealthy hosts from the load balancing
# pool for the backend service.
class OutlierDetection
include Google::Apis::Core::Hashable
# A Duration represents a fixed-length span of time represented as a count of
# seconds and fractions of seconds at nanosecond resolution. It is independent
# of any calendar and concepts like "day" or "month". Range is approximately 10,
# 000 years.
# Corresponds to the JSON property `baseEjectionTime`
# @return [Google::Apis::ComputeV1::Duration]
attr_accessor :base_ejection_time
# Number of errors before a host is ejected from the connection pool. When the
# backend host is accessed over HTTP, a 5xx return code qualifies as an error.
# Defaults to 5.
# Corresponds to the JSON property `consecutiveErrors`
# @return [Fixnum]
attr_accessor :consecutive_errors
# The number of consecutive gateway failures (502, 503, 504 status or connection
# errors that are mapped to one of those status codes) before a consecutive
# gateway failure ejection occurs. Defaults to 3.
# Corresponds to the JSON property `consecutiveGatewayFailure`
# @return [Fixnum]
attr_accessor :consecutive_gateway_failure
# The percentage chance that a host will be actually ejected when an outlier
# status is detected through consecutive 5xx. This setting can be used to
# disable ejection or to ramp it up slowly. Defaults to 0.
# Corresponds to the JSON property `enforcingConsecutiveErrors`
# @return [Fixnum]
attr_accessor :enforcing_consecutive_errors
# The percentage chance that a host will be actually ejected when an outlier
# status is detected through consecutive gateway failures. This setting can be
# used to disable ejection or to ramp it up slowly. Defaults to 100.
# Corresponds to the JSON property `enforcingConsecutiveGatewayFailure`
# @return [Fixnum]
attr_accessor :enforcing_consecutive_gateway_failure
# The percentage chance that a host will be actually ejected when an outlier
# status is detected through success rate statistics. This setting can be used
# to disable ejection or to ramp it up slowly. Defaults to 100.
# Corresponds to the JSON property `enforcingSuccessRate`
# @return [Fixnum]
attr_accessor :enforcing_success_rate
# A Duration represents a fixed-length span of time represented as a count of
# seconds and fractions of seconds at nanosecond resolution. It is independent
# of any calendar and concepts like "day" or "month". Range is approximately 10,
# 000 years.
# Corresponds to the JSON property `interval`
# @return [Google::Apis::ComputeV1::Duration]
attr_accessor :interval
# Maximum percentage of hosts in the load balancing pool for the backend service
# that can be ejected. Defaults to 50%.
# Corresponds to the JSON property `maxEjectionPercent`
# @return [Fixnum]
attr_accessor :max_ejection_percent
# The number of hosts in a cluster that must have enough request volume to
# detect success rate outliers. If the number of hosts is less than this setting,
# outlier detection via success rate statistics is not performed for any host
# in the cluster. Defaults to 5.
# Corresponds to the JSON property `successRateMinimumHosts`
# @return [Fixnum]
attr_accessor :success_rate_minimum_hosts
# The minimum number of total requests that must be collected in one interval (
# as defined by the interval duration above) to include this host in success
# rate based outlier detection. If the volume is lower than this setting,
# outlier detection via success rate statistics is not performed for that host.
# Defaults to 100.
# Corresponds to the JSON property `successRateRequestVolume`
# @return [Fixnum]
attr_accessor :success_rate_request_volume
# This factor is used to determine the ejection threshold for success rate
# outlier ejection. The ejection threshold is the difference between the mean
# success rate, and the product of this factor and the standard deviation of the
# mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is
# divided by a thousand to get a double. That is, if the desired factor is 1.9,
# the runtime value should be 1900. Defaults to 1900.
# Corresponds to the JSON property `successRateStdevFactor`
# @return [Fixnum]
attr_accessor :success_rate_stdev_factor
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@base_ejection_time = args[:base_ejection_time] if args.key?(:base_ejection_time)
@consecutive_errors = args[:consecutive_errors] if args.key?(:consecutive_errors)
@consecutive_gateway_failure = args[:consecutive_gateway_failure] if args.key?(:consecutive_gateway_failure)
@enforcing_consecutive_errors = args[:enforcing_consecutive_errors] if args.key?(:enforcing_consecutive_errors)
@enforcing_consecutive_gateway_failure = args[:enforcing_consecutive_gateway_failure] if args.key?(:enforcing_consecutive_gateway_failure)
@enforcing_success_rate = args[:enforcing_success_rate] if args.key?(:enforcing_success_rate)
@interval = args[:interval] if args.key?(:interval)
@max_ejection_percent = args[:max_ejection_percent] if args.key?(:max_ejection_percent)
@success_rate_minimum_hosts = args[:success_rate_minimum_hosts] if args.key?(:success_rate_minimum_hosts)
@success_rate_request_volume = args[:success_rate_request_volume] if args.key?(:success_rate_request_volume)
@success_rate_stdev_factor = args[:success_rate_stdev_factor] if args.key?(:success_rate_stdev_factor)
end
end
# Represents a Packet Mirroring resource.
# Packet Mirroring clones the traffic of specified instances in your Virtual
# Private Cloud (VPC) network and forwards it to a collector destination, such
# as an instance group of an internal TCP/UDP load balancer, for analysis or
# examination. For more information about setting up Packet Mirroring, see Using
# Packet Mirroring. (== resource_for `$api_version`.packetMirrorings ==)
class PacketMirroring
include Google::Apis::Core::Hashable
# The Forwarding Rule resource of type loadBalancingScheme=INTERNAL that will be
# used as collector for mirrored traffic. The specified forwarding rule must
# have isMirroringCollector set to true.
# Corresponds to the JSON property `collectorIlb`
# @return [Google::Apis::ComputeV1::PacketMirroringForwardingRuleInfo]
attr_accessor :collector_ilb
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Indicates whether or not this packet mirroring takes effect. If set to FALSE,
# this packet mirroring policy will not be enforced on the network.
# The default is TRUE.
# Corresponds to the JSON property `enable`
# @return [String]
attr_accessor :enable
# Filter for mirrored traffic. If unspecified, all traffic is mirrored.
# Corresponds to the JSON property `filter`
# @return [Google::Apis::ComputeV1::PacketMirroringFilter]
attr_accessor :filter
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] Type of the resource. Always compute#packetMirroring for packet
# mirrorings.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# PacketMirroring mirroredResourceInfos. MirroredResourceInfo specifies a set of
# mirrored VM instances, subnetworks and/or tags for which traffic from/to all
# VM instances will be mirrored.
# Corresponds to the JSON property `mirroredResources`
# @return [Google::Apis::ComputeV1::PacketMirroringMirroredResourceInfo]
attr_accessor :mirrored_resources
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Specifies the mirrored VPC network. Only packets in this network will be
# mirrored. All mirrored VMs should have a NIC in the given network. All
# mirrored subnetworks should belong to the given network.
# Corresponds to the JSON property `network`
# @return [Google::Apis::ComputeV1::PacketMirroringNetworkInfo]
attr_accessor :network
# The priority of applying this configuration. Priority is used to break ties in
# cases where there is more than one matching rule. In the case of two rules
# that apply for a given Instance, the one with the lowest-numbered priority
# value wins.
# Default value is 1000. Valid range is 0 through 65535.
# Corresponds to the JSON property `priority`
# @return [Fixnum]
attr_accessor :priority
# [Output Only] URI of the region where the packetMirroring resides.
# Corresponds to the JSON property `region`
# @return [String]
attr_accessor :region
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@collector_ilb = args[:collector_ilb] if args.key?(:collector_ilb)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@enable = args[:enable] if args.key?(:enable)
@filter = args[:filter] if args.key?(:filter)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@mirrored_resources = args[:mirrored_resources] if args.key?(:mirrored_resources)
@name = args[:name] if args.key?(:name)
@network = args[:network] if args.key?(:network)
@priority = args[:priority] if args.key?(:priority)
@region = args[:region] if args.key?(:region)
@self_link = args[:self_link] if args.key?(:self_link)
end
end
# Contains a list of packetMirrorings.
class PacketMirroringAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of PacketMirroring resources.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::PacketMirroringsScopedList>]
attr_accessor :items
# Type of resource.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::PacketMirroringAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::PacketMirroringAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class PacketMirroringFilter
include Google::Apis::Core::Hashable
# Protocols that apply as filter on mirrored traffic. If no protocols are
# specified, all traffic that matches the specified CIDR ranges is mirrored. If
# neither cidrRanges nor IPProtocols is specified, all traffic is mirrored.
# Corresponds to the JSON property `IPProtocols`
# @return [Array<String>]
attr_accessor :ip_protocols
# IP CIDR ranges that apply as filter on the source (ingress) or destination (
# egress) IP in the IP header. Only IPv4 is supported. If no ranges are
# specified, all traffic that matches the specified IPProtocols is mirrored. If
# neither cidrRanges nor IPProtocols is specified, all traffic is mirrored.
# Corresponds to the JSON property `cidrRanges`
# @return [Array<String>]
attr_accessor :cidr_ranges
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@ip_protocols = args[:ip_protocols] if args.key?(:ip_protocols)
@cidr_ranges = args[:cidr_ranges] if args.key?(:cidr_ranges)
end
end
#
class PacketMirroringForwardingRuleInfo
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the forwarding rule; defined by the server.
# Corresponds to the JSON property `canonicalUrl`
# @return [String]
attr_accessor :canonical_url
# Resource URL to the forwarding rule representing the ILB configured as
# destination of the mirrored traffic.
# Corresponds to the JSON property `url`
# @return [String]
attr_accessor :url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@canonical_url = args[:canonical_url] if args.key?(:canonical_url)
@url = args[:url] if args.key?(:url)
end
end
# Contains a list of PacketMirroring resources.
class PacketMirroringList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of PacketMirroring resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::PacketMirroring>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#packetMirroring for
# packetMirrorings.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::PacketMirroringList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::PacketMirroringList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class PacketMirroringMirroredResourceInfo
include Google::Apis::Core::Hashable
# A set of virtual machine instances that are being mirrored. They must live in
# zones contained in the same region as this packetMirroring.
# Note that this config will apply only to those network interfaces of the
# Instances that belong to the network specified in this packetMirroring.
# You may specify a maximum of 50 Instances.
# Corresponds to the JSON property `instances`
# @return [Array<Google::Apis::ComputeV1::PacketMirroringMirroredResourceInfoInstanceInfo>]
attr_accessor :instances
# A set of subnetworks for which traffic from/to all VM instances will be
# mirrored. They must live in the same region as this packetMirroring.
# You may specify a maximum of 5 subnetworks.
# Corresponds to the JSON property `subnetworks`
# @return [Array<Google::Apis::ComputeV1::PacketMirroringMirroredResourceInfoSubnetInfo>]
attr_accessor :subnetworks
# A set of mirrored tags. Traffic from/to all VM instances that have one or more
# of these tags will be mirrored.
# Corresponds to the JSON property `tags`
# @return [Array<String>]
attr_accessor :tags
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@instances = args[:instances] if args.key?(:instances)
@subnetworks = args[:subnetworks] if args.key?(:subnetworks)
@tags = args[:tags] if args.key?(:tags)
end
end
#
class PacketMirroringMirroredResourceInfoInstanceInfo
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the instance; defined by the server.
# Corresponds to the JSON property `canonicalUrl`
# @return [String]
attr_accessor :canonical_url
# Resource URL to the virtual machine instance which is being mirrored.
# Corresponds to the JSON property `url`
# @return [String]
attr_accessor :url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@canonical_url = args[:canonical_url] if args.key?(:canonical_url)
@url = args[:url] if args.key?(:url)
end
end
#
class PacketMirroringMirroredResourceInfoSubnetInfo
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the subnetwork; defined by the server.
# Corresponds to the JSON property `canonicalUrl`
# @return [String]
attr_accessor :canonical_url
# Resource URL to the subnetwork for which traffic from/to all VM instances will
# be mirrored.
# Corresponds to the JSON property `url`
# @return [String]
attr_accessor :url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@canonical_url = args[:canonical_url] if args.key?(:canonical_url)
@url = args[:url] if args.key?(:url)
end
end
#
class PacketMirroringNetworkInfo
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the network; defined by the server.
# Corresponds to the JSON property `canonicalUrl`
# @return [String]
attr_accessor :canonical_url
# URL of the network resource.
# Corresponds to the JSON property `url`
# @return [String]
attr_accessor :url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@canonical_url = args[:canonical_url] if args.key?(:canonical_url)
@url = args[:url] if args.key?(:url)
end
end
#
class PacketMirroringsScopedList
include Google::Apis::Core::Hashable
# A list of packetMirrorings contained in this scope.
# Corresponds to the JSON property `packetMirrorings`
# @return [Array<Google::Apis::ComputeV1::PacketMirroring>]
attr_accessor :packet_mirrorings
# Informational warning which replaces the list of packetMirrorings when the
# list is empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::PacketMirroringsScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@packet_mirrorings = args[:packet_mirrorings] if args.key?(:packet_mirrorings)
@warning = args[:warning] if args.key?(:warning)
end
# Informational warning which replaces the list of packetMirrorings when the
# list is empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::PacketMirroringsScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# A matcher for the path portion of the URL. The BackendService from the longest-
# matched rule will serve the URL. If no rule was matched, the default service
# will be used.
class PathMatcher
include Google::Apis::Core::Hashable
# defaultRouteAction takes effect when none of the pathRules or routeRules
# match. The load balancer performs advanced routing actions like URL rewrites,
# header transformations, etc. prior to forwarding the request to the selected
# backend. If defaultRouteAction specifies any weightedBackendServices,
# defaultService must not be set. Conversely if defaultService is set,
# defaultRouteAction cannot contain any weightedBackendServices.
# Only one of defaultRouteAction or defaultUrlRedirect must be set.
# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action
# within a pathMatcher's defaultRouteAction.
# Corresponds to the JSON property `defaultRouteAction`
# @return [Google::Apis::ComputeV1::HttpRouteAction]
attr_accessor :default_route_action
# The full or partial URL to the BackendService resource. This will be used if
# none of the pathRules or routeRules defined by this PathMatcher are matched.
# For example, the following are all valid URLs to a BackendService resource:
# - https://www.googleapis.com/compute/v1/projects/project/global/
# backendServices/backendService
# - compute/v1/projects/project/global/backendServices/backendService
# - global/backendServices/backendService If defaultRouteAction is additionally
# specified, advanced routing actions like URL Rewrites, etc. take effect prior
# to sending the request to the backend. However, if defaultService is specified,
# defaultRouteAction cannot contain any weightedBackendServices. Conversely, if
# defaultRouteAction specifies any weightedBackendServices, defaultService must
# not be specified.
# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.
# weightedBackendService must be set.
# Authorization requires one or more of the following Google IAM permissions on
# the specified resource default_service:
# - compute.backendBuckets.use
# - compute.backendServices.use
# Corresponds to the JSON property `defaultService`
# @return [String]
attr_accessor :default_service
# Specifies settings for an HTTP redirect.
# Corresponds to the JSON property `defaultUrlRedirect`
# @return [Google::Apis::ComputeV1::HttpRedirectAction]
attr_accessor :default_url_redirect
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# The request and response header transformations that take effect before the
# request is passed along to the selected backendService.
# Corresponds to the JSON property `headerAction`
# @return [Google::Apis::ComputeV1::HttpHeaderAction]
attr_accessor :header_action
# The name to which this PathMatcher is referred by the HostRule.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The list of path rules. Use this list instead of routeRules when routing based
# on simple path matching is all that's required. The order by which path rules
# are specified does not matter. Matches are always done on the longest-path-
# first basis.
# For example: a pathRule with a path /a/b/c/* will match before /a/b/*
# irrespective of the order in which those paths appear in this list.
# Within a given pathMatcher, only one of pathRules or routeRules must be set.
# Corresponds to the JSON property `pathRules`
# @return [Array<Google::Apis::ComputeV1::PathRule>]
attr_accessor :path_rules
# The list of HTTP route rules. Use this list instead of pathRules when advanced
# route matching and routing actions are desired. routeRules are evaluated in
# order of priority, from the lowest to highest number.
# Within a given pathMatcher, you can set only one of pathRules or routeRules.
# Corresponds to the JSON property `routeRules`
# @return [Array<Google::Apis::ComputeV1::HttpRouteRule>]
attr_accessor :route_rules
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@default_route_action = args[:default_route_action] if args.key?(:default_route_action)
@default_service = args[:default_service] if args.key?(:default_service)
@default_url_redirect = args[:default_url_redirect] if args.key?(:default_url_redirect)
@description = args[:description] if args.key?(:description)
@header_action = args[:header_action] if args.key?(:header_action)
@name = args[:name] if args.key?(:name)
@path_rules = args[:path_rules] if args.key?(:path_rules)
@route_rules = args[:route_rules] if args.key?(:route_rules)
end
end
# A path-matching rule for a URL. If matched, will use the specified
# BackendService to handle the traffic arriving at this URL.
class PathRule
include Google::Apis::Core::Hashable
# The list of path patterns to match. Each must start with / and the only place
# a * is allowed is at the end following a /. The string fed to the path matcher
# does not include any text after the first ? or #, and those chars are not
# allowed here.
# Corresponds to the JSON property `paths`
# @return [Array<String>]
attr_accessor :paths
# In response to a matching path, the load balancer performs advanced routing
# actions like URL rewrites, header transformations, etc. prior to 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 routeAction or urlRedirect must be set.
# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action
# within a pathRule's routeAction.
# Corresponds to the JSON property `routeAction`
# @return [Google::Apis::ComputeV1::HttpRouteAction]
attr_accessor :route_action
# The full or partial URL of the backend service resource to which traffic is
# directed if this rule is matched. If routeAction is additionally specified,
# advanced routing actions like URL Rewrites, etc. take effect prior to sending
# the request to the backend. However, if service is specified, routeAction
# cannot contain any weightedBackendService s. Conversely, if routeAction
# specifies any weightedBackendServices, service must not be specified.
# Only one of urlRedirect, service or routeAction.weightedBackendService must be
# set.
# Corresponds to the JSON property `service`
# @return [String]
attr_accessor :service
# Specifies settings for an HTTP redirect.
# Corresponds to the JSON property `urlRedirect`
# @return [Google::Apis::ComputeV1::HttpRedirectAction]
attr_accessor :url_redirect
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@paths = args[:paths] if args.key?(:paths)
@route_action = args[:route_action] if args.key?(:route_action)
@service = args[:service] if args.key?(:service)
@url_redirect = args[:url_redirect] if args.key?(:url_redirect)
end
end
#
class PerInstanceConfig
include Google::Apis::Core::Hashable
# Fingerprint of this per-instance config. This field can be used in optimistic
# locking. It is ignored when inserting a per-instance config. An up-to-date
# fingerprint must be provided in order to update an existing per-instance
# config or the field needs to be unset.
# Corresponds to the JSON property `fingerprint`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :fingerprint
# The name of a per-instance config and its corresponding instance. Serves as a
# merge key during UpdatePerInstanceConfigs operations, that is, if a per-
# instance config with the same name exists then it will be updated, otherwise a
# new one will be created for the VM instance with the same name. An attempt to
# create a per-instance config for a VM instance that either doesn't exist or is
# not part of the group will result in an error.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@fingerprint = args[:fingerprint] if args.key?(:fingerprint)
@name = args[:name] if args.key?(:name)
end
end
# An Identity and Access Management (IAM) policy, which specifies access
# controls for Google Cloud resources.
# A `Policy` is a collection of `bindings`. A `binding` binds one or more `
# members` to a single `role`. Members can be user accounts, service accounts,
# Google groups, and domains (such as G Suite). A `role` is a named list of
# permissions; each `role` can be an IAM predefined role or a user-created
# custom role.
# For some types of Google Cloud resources, a `binding` can also specify a `
# condition`, which is a logical expression that allows access to a resource
# only if the expression evaluates to `true`. A condition can add constraints
# based on attributes of the request, the resource, or both. To learn which
# resources support conditions in their IAM policies, see the [IAM documentation]
# (https://cloud.google.com/iam/help/conditions/resource-policies).
# **JSON example:**
# ` "bindings": [ ` "role": "roles/resourcemanager.organizationAdmin", "members":
# [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "
# serviceAccount:my-project-id@appspot.gserviceaccount.com" ] `, ` "role": "
# roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com"
# ], "condition": ` "title": "expirable access", "description": "Does not grant
# access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:
# 00:00.000Z')", ` ` ], "etag": "BwWWja0YfJA=", "version": 3 `
# **YAML example:**
# bindings: - members: - user:mike@example.com - group:admins@example.com -
# domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com
# role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.
# com role: roles/resourcemanager.organizationViewer condition: title: expirable
# access description: Does not grant access after Sep 2020 expression: request.
# time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3
# For a description of IAM and its features, see the [IAM documentation](https://
# cloud.google.com/iam/docs/).
class Policy
include Google::Apis::Core::Hashable
# Specifies cloud audit logging configuration for this policy.
# Corresponds to the JSON property `auditConfigs`
# @return [Array<Google::Apis::ComputeV1::AuditConfig>]
attr_accessor :audit_configs
# Associates a list of `members` to a `role`. Optionally, may specify a `
# condition` that determines how and when the `bindings` are applied. Each of
# the `bindings` must contain at least one member.
# Corresponds to the JSON property `bindings`
# @return [Array<Google::Apis::ComputeV1::Binding>]
attr_accessor :bindings
# `etag` is used for optimistic concurrency control as a way to help prevent
# simultaneous updates of a policy from overwriting each other. It is strongly
# suggested that systems make use of the `etag` in the read-modify-write cycle
# to perform policy updates in order to avoid race conditions: An `etag` is
# returned in the response to `getIamPolicy`, and systems are expected to put
# that etag in the request to `setIamPolicy` to ensure that their change will be
# applied to the same version of the policy.
# **Important:** If you use IAM Conditions, you must include the `etag` field
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows you
# to overwrite a version `3` policy with a version `1` policy, and all of the
# conditions in the version `3` policy are lost.
# Corresponds to the JSON property `etag`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :etag
#
# Corresponds to the JSON property `iamOwned`
# @return [Boolean]
attr_accessor :iam_owned
alias_method :iam_owned?, :iam_owned
# If more than one rule is specified, the rules are applied in the following
# manner: - All matching LOG rules are always applied. - If any DENY/
# DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if
# one or more matching rule requires logging. - Otherwise, if any ALLOW/
# ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if
# one or more matching rule requires logging. - Otherwise, if no rule applies,
# permission is denied.
# Corresponds to the JSON property `rules`
# @return [Array<Google::Apis::ComputeV1::Rule>]
attr_accessor :rules
# Specifies the format of the policy.
# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are
# rejected.
# Any operation that affects conditional role bindings must specify version `3`.
# This requirement applies to the following operations:
# * Getting a policy that includes a conditional role binding * Adding a
# conditional role binding to a policy * Changing a conditional role binding in
# a policy * Removing any role binding, with or without a condition, from a
# policy that includes conditions
# **Important:** If you use IAM Conditions, you must include the `etag` field
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows you
# to overwrite a version `3` policy with a version `1` policy, and all of the
# conditions in the version `3` policy are lost.
# If a policy does not include any conditions, operations on that policy may
# specify any valid version or leave the field unset.
# To learn which resources support conditions in their IAM policies, see the [
# IAM documentation](https://cloud.google.com/iam/help/conditions/resource-
# policies).
# Corresponds to the JSON property `version`
# @return [Fixnum]
attr_accessor :version
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@audit_configs = args[:audit_configs] if args.key?(:audit_configs)
@bindings = args[:bindings] if args.key?(:bindings)
@etag = args[:etag] if args.key?(:etag)
@iam_owned = args[:iam_owned] if args.key?(:iam_owned)
@rules = args[:rules] if args.key?(:rules)
@version = args[:version] if args.key?(:version)
end
end
#
class PreconfiguredWafSet
include Google::Apis::Core::Hashable
# List of entities that are currently supported for WAF rules.
# Corresponds to the JSON property `expressionSets`
# @return [Array<Google::Apis::ComputeV1::WafExpressionSet>]
attr_accessor :expression_sets
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@expression_sets = args[:expression_sets] if args.key?(:expression_sets)
end
end
# Represents a Project resource.
# A project is used to organize resources in a Google Cloud Platform environment.
# For more information, read about the Resource Hierarchy. (== resource_for `$
# api_version`.projects ==)
class Project
include Google::Apis::Core::Hashable
# A metadata key/value entry.
# Corresponds to the JSON property `commonInstanceMetadata`
# @return [Google::Apis::ComputeV1::Metadata]
attr_accessor :common_instance_metadata
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# This signifies the default network tier used for configuring resources of the
# project and can only take the following values: PREMIUM, STANDARD. Initially
# the default network tier is PREMIUM.
# Corresponds to the JSON property `defaultNetworkTier`
# @return [String]
attr_accessor :default_network_tier
# [Output Only] Default service account used by VMs running in this project.
# Corresponds to the JSON property `defaultServiceAccount`
# @return [String]
attr_accessor :default_service_account
# An optional textual description of the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Restricted features enabled for use on this project.
# Corresponds to the JSON property `enabledFeatures`
# @return [Array<String>]
attr_accessor :enabled_features
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server. This is not the project ID, and is just a unique ID
# used by Compute Engine to identify resources.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] Type of the resource. Always compute#project for projects.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# The project ID. For example: my-example-project. Use the project ID to make
# requests to Compute Engine.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# [Output Only] Quotas assigned to this project.
# Corresponds to the JSON property `quotas`
# @return [Array<Google::Apis::ComputeV1::Quota>]
attr_accessor :quotas
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# The location in Cloud Storage and naming method of the daily usage report.
# Contains bucket_name and report_name prefix.
# Corresponds to the JSON property `usageExportLocation`
# @return [Google::Apis::ComputeV1::UsageExportLocation]
attr_accessor :usage_export_location
# [Output Only] The role this project has in a shared VPC configuration.
# Currently only HOST projects are differentiated.
# Corresponds to the JSON property `xpnProjectStatus`
# @return [String]
attr_accessor :xpn_project_status
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@common_instance_metadata = args[:common_instance_metadata] if args.key?(:common_instance_metadata)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@default_network_tier = args[:default_network_tier] if args.key?(:default_network_tier)
@default_service_account = args[:default_service_account] if args.key?(:default_service_account)
@description = args[:description] if args.key?(:description)
@enabled_features = args[:enabled_features] if args.key?(:enabled_features)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@quotas = args[:quotas] if args.key?(:quotas)
@self_link = args[:self_link] if args.key?(:self_link)
@usage_export_location = args[:usage_export_location] if args.key?(:usage_export_location)
@xpn_project_status = args[:xpn_project_status] if args.key?(:xpn_project_status)
end
end
#
class ProjectsDisableXpnResourceRequest
include Google::Apis::Core::Hashable
# Service resource (a.k.a service project) ID.
# Corresponds to the JSON property `xpnResource`
# @return [Google::Apis::ComputeV1::XpnResourceId]
attr_accessor :xpn_resource
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@xpn_resource = args[:xpn_resource] if args.key?(:xpn_resource)
end
end
#
class ProjectsEnableXpnResourceRequest
include Google::Apis::Core::Hashable
# Service resource (a.k.a service project) ID.
# Corresponds to the JSON property `xpnResource`
# @return [Google::Apis::ComputeV1::XpnResourceId]
attr_accessor :xpn_resource
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@xpn_resource = args[:xpn_resource] if args.key?(:xpn_resource)
end
end
#
class ProjectsGetXpnResources
include Google::Apis::Core::Hashable
# [Output Only] Type of resource. Always compute#projectsGetXpnResources for
# lists of service resources (a.k.a service projects)
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# Service resources (a.k.a service projects) attached to this project as their
# shared VPC host.
# Corresponds to the JSON property `resources`
# @return [Array<Google::Apis::ComputeV1::XpnResourceId>]
attr_accessor :resources
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@resources = args[:resources] if args.key?(:resources)
end
end
#
class ProjectsListXpnHostsRequest
include Google::Apis::Core::Hashable
# Optional organization ID managed by Cloud Resource Manager, for which to list
# shared VPC host projects. If not specified, the organization will be inferred
# from the project.
# Corresponds to the JSON property `organization`
# @return [String]
attr_accessor :organization
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@organization = args[:organization] if args.key?(:organization)
end
end
#
class ProjectsSetDefaultNetworkTierRequest
include Google::Apis::Core::Hashable
# Default network tier to be set.
# Corresponds to the JSON property `networkTier`
# @return [String]
attr_accessor :network_tier
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@network_tier = args[:network_tier] if args.key?(:network_tier)
end
end
# A quotas entry.
class Quota
include Google::Apis::Core::Hashable
# [Output Only] Quota limit for this metric.
# Corresponds to the JSON property `limit`
# @return [Float]
attr_accessor :limit
# [Output Only] Name of the quota metric.
# Corresponds to the JSON property `metric`
# @return [String]
attr_accessor :metric
# [Output Only] Owning resource. This is the resource on which this quota is
# applied.
# Corresponds to the JSON property `owner`
# @return [String]
attr_accessor :owner
# [Output Only] Current usage of this metric.
# Corresponds to the JSON property `usage`
# @return [Float]
attr_accessor :usage
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@limit = args[:limit] if args.key?(:limit)
@metric = args[:metric] if args.key?(:metric)
@owner = args[:owner] if args.key?(:owner)
@usage = args[:usage] if args.key?(:usage)
end
end
# Represents a reference to a resource.
class Reference
include Google::Apis::Core::Hashable
# [Output Only] Type of the resource. Always compute#reference for references.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# A description of the reference type with no implied semantics. Possible values
# include:
# - MEMBER_OF
# Corresponds to the JSON property `referenceType`
# @return [String]
attr_accessor :reference_type
# URL of the resource which refers to the target.
# Corresponds to the JSON property `referrer`
# @return [String]
attr_accessor :referrer
# URL of the resource to which this reference points.
# Corresponds to the JSON property `target`
# @return [String]
attr_accessor :target
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@kind = args[:kind] if args.key?(:kind)
@reference_type = args[:reference_type] if args.key?(:reference_type)
@referrer = args[:referrer] if args.key?(:referrer)
@target = args[:target] if args.key?(:target)
end
end
# Represents a Region resource.
# A region is a geographical area where a resource is located. For more
# information, read Regions and Zones. (== resource_for `$api_version`.regions ==
# )
class Region
include Google::Apis::Core::Hashable
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# Deprecation status for a public resource.
# Corresponds to the JSON property `deprecated`
# @return [Google::Apis::ComputeV1::DeprecationStatus]
attr_accessor :deprecated
# [Output Only] Textual description of the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] Type of the resource. Always compute#region for regions.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] Name of the resource.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# [Output Only] Quotas assigned to this region.
# Corresponds to the JSON property `quotas`
# @return [Array<Google::Apis::ComputeV1::Quota>]
attr_accessor :quotas
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Status of the region, either UP or DOWN.
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
# [Output Only] A list of zones available in this region, in the form of
# resource URLs.
# Corresponds to the JSON property `zones`
# @return [Array<String>]
attr_accessor :zones
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@deprecated = args[:deprecated] if args.key?(:deprecated)
@description = args[:description] if args.key?(:description)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@quotas = args[:quotas] if args.key?(:quotas)
@self_link = args[:self_link] if args.key?(:self_link)
@status = args[:status] if args.key?(:status)
@zones = args[:zones] if args.key?(:zones)
end
end
# Contains a list of autoscalers.
class RegionAutoscalerList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of Autoscaler resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::Autoscaler>]
attr_accessor :items
# Type of resource.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::RegionAutoscalerList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::RegionAutoscalerList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class RegionDiskTypeList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of DiskType resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::DiskType>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#regionDiskTypeList for region
# disk types.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::RegionDiskTypeList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::RegionDiskTypeList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class RegionDisksAddResourcePoliciesRequest
include Google::Apis::Core::Hashable
# Resource policies to be added to this disk.
# Corresponds to the JSON property `resourcePolicies`
# @return [Array<String>]
attr_accessor :resource_policies
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@resource_policies = args[:resource_policies] if args.key?(:resource_policies)
end
end
#
class RegionDisksRemoveResourcePoliciesRequest
include Google::Apis::Core::Hashable
# Resource policies to be removed from this disk.
# Corresponds to the JSON property `resourcePolicies`
# @return [Array<String>]
attr_accessor :resource_policies
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@resource_policies = args[:resource_policies] if args.key?(:resource_policies)
end
end
#
class RegionDisksResizeRequest
include Google::Apis::Core::Hashable
# The new size of the regional persistent disk, which is specified in GB.
# Corresponds to the JSON property `sizeGb`
# @return [Fixnum]
attr_accessor :size_gb
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@size_gb = args[:size_gb] if args.key?(:size_gb)
end
end
# Contains a list of InstanceGroup resources.
class RegionInstanceGroupList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of InstanceGroup resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::InstanceGroup>]
attr_accessor :items
# The resource type.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::RegionInstanceGroupList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::RegionInstanceGroupList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Contains a list of managed instance groups.
class RegionInstanceGroupManagerList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of InstanceGroupManager resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::InstanceGroupManager>]
attr_accessor :items
# [Output Only] The resource type, which is always compute#
# instanceGroupManagerList for a list of managed instance groups that exist in
# th regional scope.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::RegionInstanceGroupManagerList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::RegionInstanceGroupManagerList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class RegionInstanceGroupManagersAbandonInstancesRequest
include Google::Apis::Core::Hashable
# The URLs of one or more instances to abandon. This can be a full URL or a
# partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
# Corresponds to the JSON property `instances`
# @return [Array<String>]
attr_accessor :instances
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@instances = args[:instances] if args.key?(:instances)
end
end
# InstanceGroupManagers.applyUpdatesToInstances
class RegionInstanceGroupManagersApplyUpdatesRequest
include Google::Apis::Core::Hashable
# The list of URLs of one or more instances for which you want to apply updates.
# Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[
# INSTANCE_NAME].
# Corresponds to the JSON property `instances`
# @return [Array<String>]
attr_accessor :instances
# The minimal action that you want to perform on each instance during the update:
#
# - REPLACE: At minimum, delete the instance and create it again.
# - RESTART: Stop the instance and start it again.
# - REFRESH: Do not stop the instance.
# - NONE: Do not disrupt the instance at all. By default, the minimum action is
# NONE. If your update requires a more disruptive action than you set with this
# flag, the necessary action is performed to execute the update.
# Corresponds to the JSON property `minimalAction`
# @return [String]
attr_accessor :minimal_action
# The most disruptive action that you want to perform on each instance during
# the update:
# - REPLACE: Delete the instance and create it again.
# - RESTART: Stop the instance and start it again.
# - REFRESH: Do not stop the instance.
# - NONE: Do not disrupt the instance at all. By default, the most disruptive
# allowed action is REPLACE. If your update requires a more disruptive action
# than you set with this flag, the update request will fail.
# Corresponds to the JSON property `mostDisruptiveAllowedAction`
# @return [String]
attr_accessor :most_disruptive_allowed_action
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@instances = args[:instances] if args.key?(:instances)
@minimal_action = args[:minimal_action] if args.key?(:minimal_action)
@most_disruptive_allowed_action = args[:most_disruptive_allowed_action] if args.key?(:most_disruptive_allowed_action)
end
end
# RegionInstanceGroupManagers.createInstances
class RegionInstanceGroupManagersCreateInstancesRequest
include Google::Apis::Core::Hashable
# [Required] List of specifications of per-instance configs.
# Corresponds to the JSON property `instances`
# @return [Array<Google::Apis::ComputeV1::PerInstanceConfig>]
attr_accessor :instances
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@instances = args[:instances] if args.key?(:instances)
end
end
#
class RegionInstanceGroupManagersDeleteInstancesRequest
include Google::Apis::Core::Hashable
# The URLs of one or more instances to delete. This can be a full URL or a
# partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
# Corresponds to the JSON property `instances`
# @return [Array<String>]
attr_accessor :instances
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@instances = args[:instances] if args.key?(:instances)
end
end
#
class RegionInstanceGroupManagersListErrorsResponse
include Google::Apis::Core::Hashable
# [Output Only] The list of errors of the managed instance group.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::InstanceManagedByIgmError>]
attr_accessor :items
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@items = args[:items] if args.key?(:items)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
#
class RegionInstanceGroupManagersListInstancesResponse
include Google::Apis::Core::Hashable
# A list of managed instances.
# Corresponds to the JSON property `managedInstances`
# @return [Array<Google::Apis::ComputeV1::ManagedInstance>]
attr_accessor :managed_instances
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@managed_instances = args[:managed_instances] if args.key?(:managed_instances)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
end
end
#
class RegionInstanceGroupManagersRecreateRequest
include Google::Apis::Core::Hashable
# The URLs of one or more instances to recreate. This can be a full URL or a
# partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].
# Corresponds to the JSON property `instances`
# @return [Array<String>]
attr_accessor :instances
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@instances = args[:instances] if args.key?(:instances)
end
end
#
class RegionInstanceGroupManagersSetTargetPoolsRequest
include Google::Apis::Core::Hashable
# Fingerprint of the target pools information, which is a hash of the contents.
# This field is used for optimistic locking when you update the target pool
# entries. This field is optional.
# Corresponds to the JSON property `fingerprint`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :fingerprint
# The URL of all TargetPool resources to which instances in the instanceGroup
# field are added. The target pools automatically apply to all of the instances
# in the managed instance group.
# Corresponds to the JSON property `targetPools`
# @return [Array<String>]
attr_accessor :target_pools
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@fingerprint = args[:fingerprint] if args.key?(:fingerprint)
@target_pools = args[:target_pools] if args.key?(:target_pools)
end
end
#
class RegionInstanceGroupManagersSetTemplateRequest
include Google::Apis::Core::Hashable
# URL of the InstanceTemplate resource from which all new instances will be
# created.
# Corresponds to the JSON property `instanceTemplate`
# @return [String]
attr_accessor :instance_template
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@instance_template = args[:instance_template] if args.key?(:instance_template)
end
end
#
class RegionInstanceGroupsListInstances
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of InstanceWithNamedPorts resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::InstanceWithNamedPorts>]
attr_accessor :items
# The resource type.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::RegionInstanceGroupsListInstances::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::RegionInstanceGroupsListInstances::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class RegionInstanceGroupsListInstancesRequest
include Google::Apis::Core::Hashable
# Instances in which state should be returned. Valid options are: 'ALL', '
# RUNNING'. By default, it lists all instances.
# Corresponds to the JSON property `instanceState`
# @return [String]
attr_accessor :instance_state
# Name of port user is interested in. It is optional. If it is set, only
# information about this ports will be returned. If it is not set, all the named
# ports will be returned. Always lists all instances.
# Corresponds to the JSON property `portName`
# @return [String]
attr_accessor :port_name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@instance_state = args[:instance_state] if args.key?(:instance_state)
@port_name = args[:port_name] if args.key?(:port_name)
end
end
#
class RegionInstanceGroupsSetNamedPortsRequest
include Google::Apis::Core::Hashable
# The fingerprint of the named ports information for this instance group. Use
# this optional property to prevent conflicts when multiple users change the
# named ports settings concurrently. Obtain the fingerprint with the
# instanceGroups.get method. Then, include the fingerprint in your request to
# ensure that you do not overwrite changes that were applied from another
# concurrent request.
# Corresponds to the JSON property `fingerprint`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :fingerprint
# The list of named ports to set for this instance group.
# Corresponds to the JSON property `namedPorts`
# @return [Array<Google::Apis::ComputeV1::NamedPort>]
attr_accessor :named_ports
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@fingerprint = args[:fingerprint] if args.key?(:fingerprint)
@named_ports = args[:named_ports] if args.key?(:named_ports)
end
end
# Contains a list of region resources.
class RegionList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of Region resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::Region>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#regionList for lists of regions.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::RegionList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::RegionList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class RegionSetLabelsRequest
include Google::Apis::Core::Hashable
# The fingerprint of the previous set of labels for this resource, used to
# detect conflicts. 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.
# Make a get() request to the resource to get the latest fingerprint.
# Corresponds to the JSON property `labelFingerprint`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :label_fingerprint
# The labels to set for this resource.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint)
@labels = args[:labels] if args.key?(:labels)
end
end
#
class RegionSetPolicyRequest
include Google::Apis::Core::Hashable
# Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use '
# policy' to specify bindings.
# Corresponds to the JSON property `bindings`
# @return [Array<Google::Apis::ComputeV1::Binding>]
attr_accessor :bindings
# Flatten Policy to create a backward compatible wire-format. Deprecated. Use '
# policy' to specify the etag.
# Corresponds to the JSON property `etag`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :etag
# An Identity and Access Management (IAM) policy, which specifies access
# controls for Google Cloud resources.
# A `Policy` is a collection of `bindings`. A `binding` binds one or more `
# members` to a single `role`. Members can be user accounts, service accounts,
# Google groups, and domains (such as G Suite). A `role` is a named list of
# permissions; each `role` can be an IAM predefined role or a user-created
# custom role.
# For some types of Google Cloud resources, a `binding` can also specify a `
# condition`, which is a logical expression that allows access to a resource
# only if the expression evaluates to `true`. A condition can add constraints
# based on attributes of the request, the resource, or both. To learn which
# resources support conditions in their IAM policies, see the [IAM documentation]
# (https://cloud.google.com/iam/help/conditions/resource-policies).
# **JSON example:**
# ` "bindings": [ ` "role": "roles/resourcemanager.organizationAdmin", "members":
# [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "
# serviceAccount:my-project-id@appspot.gserviceaccount.com" ] `, ` "role": "
# roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com"
# ], "condition": ` "title": "expirable access", "description": "Does not grant
# access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:
# 00:00.000Z')", ` ` ], "etag": "BwWWja0YfJA=", "version": 3 `
# **YAML example:**
# bindings: - members: - user:mike@example.com - group:admins@example.com -
# domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com
# role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.
# com role: roles/resourcemanager.organizationViewer condition: title: expirable
# access description: Does not grant access after Sep 2020 expression: request.
# time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3
# For a description of IAM and its features, see the [IAM documentation](https://
# cloud.google.com/iam/docs/).
# Corresponds to the JSON property `policy`
# @return [Google::Apis::ComputeV1::Policy]
attr_accessor :policy
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@bindings = args[:bindings] if args.key?(:bindings)
@etag = args[:etag] if args.key?(:etag)
@policy = args[:policy] if args.key?(:policy)
end
end
#
class RegionTargetHttpsProxiesSetSslCertificatesRequest
include Google::Apis::Core::Hashable
# New set of SslCertificate resources to associate with this TargetHttpsProxy
# resource. Currently exactly one SslCertificate resource must be specified.
# Corresponds to the JSON property `sslCertificates`
# @return [Array<String>]
attr_accessor :ssl_certificates
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@ssl_certificates = args[:ssl_certificates] if args.key?(:ssl_certificates)
end
end
#
class RegionUrlMapsValidateRequest
include Google::Apis::Core::Hashable
# Represents a URL Map resource.
# Google Compute Engine has two URL Map resources:
# * [Global](/compute/docs/reference/rest/`$api_version`/urlMaps) * [Regional](/
# compute/docs/reference/rest/`$api_version`/regionUrlMaps)
# A URL map resource is a component of certain types of GCP load balancers and
# Traffic Director.
# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. *
# regionUrlMaps are used by internal HTTP(S) load balancers.
# This resource defines mappings from host names and URL paths to either a
# backend service or a backend bucket.
# To use the global urlMaps resource, the backend service must have a
# loadBalancingScheme of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the
# regionUrlMaps resource, the backend service must have a loadBalancingScheme of
# INTERNAL_MANAGED. For more information, read URL Map Concepts.
# Corresponds to the JSON property `resource`
# @return [Google::Apis::ComputeV1::UrlMap]
attr_accessor :resource
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@resource = args[:resource] if args.key?(:resource)
end
end
# A policy that specifies how requests intended for the route's backends are
# shadowed to a separate mirrored backend service. Loadbalancer does not wait
# for responses from the shadow service. Prior to sending traffic to the shadow
# service, the host / authority header is suffixed with -shadow.
class RequestMirrorPolicy
include Google::Apis::Core::Hashable
# The full or partial URL to the BackendService resource being mirrored to.
# Corresponds to the JSON property `backendService`
# @return [String]
attr_accessor :backend_service
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@backend_service = args[:backend_service] if args.key?(:backend_service)
end
end
# Represents a reservation resource. A reservation ensures that capacity is held
# in a specific zone even if the reserved VMs are not running. For more
# information, read Reserving zonal resources. (== resource_for `$api_version`.
# reservations ==)
class Reservation
include Google::Apis::Core::Hashable
# [Output Only] Full or partial URL to a parent commitment. This field displays
# for reservations that are tied to a commitment.
# Corresponds to the JSON property `commitment`
# @return [String]
attr_accessor :commitment
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] Type of the resource. Always compute#reservations for
# reservations.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# [Output Only] Server-defined fully-qualified URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# This reservation type allows to pre allocate specific instance configuration.
# Corresponds to the JSON property `specificReservation`
# @return [Google::Apis::ComputeV1::AllocationSpecificSkuReservation]
attr_accessor :specific_reservation
# Indicates whether the reservation can be consumed by VMs with affinity for "
# any" reservation. If the field is set, then only VMs that target the
# reservation by name can consume from this reservation.
# Corresponds to the JSON property `specificReservationRequired`
# @return [Boolean]
attr_accessor :specific_reservation_required
alias_method :specific_reservation_required?, :specific_reservation_required
# [Output Only] The status of the reservation.
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
# Zone in which the reservation resides. A zone must be provided if the
# reservation is created within a commitment.
# Corresponds to the JSON property `zone`
# @return [String]
attr_accessor :zone
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@commitment = args[:commitment] if args.key?(:commitment)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@self_link = args[:self_link] if args.key?(:self_link)
@specific_reservation = args[:specific_reservation] if args.key?(:specific_reservation)
@specific_reservation_required = args[:specific_reservation_required] if args.key?(:specific_reservation_required)
@status = args[:status] if args.key?(:status)
@zone = args[:zone] if args.key?(:zone)
end
end
# Specifies the reservations that this instance can consume from.
class ReservationAffinity
include Google::Apis::Core::Hashable
# 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.
# Corresponds to the JSON property `consumeReservationType`
# @return [String]
attr_accessor :consume_reservation_type
# Corresponds to the label key of a reservation resource. To target a
# SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the
# key and specify the name of your reservation as its value.
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# Corresponds to the label values of a reservation resource.
# Corresponds to the JSON property `values`
# @return [Array<String>]
attr_accessor :values
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@consume_reservation_type = args[:consume_reservation_type] if args.key?(:consume_reservation_type)
@key = args[:key] if args.key?(:key)
@values = args[:values] if args.key?(:values)
end
end
# Contains a list of reservations.
class ReservationAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of Allocation resources.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::ReservationsScopedList>]
attr_accessor :items
# Type of resource.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::ReservationAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::ReservationAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class ReservationList
include Google::Apis::Core::Hashable
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# [Output Only] A list of Allocation resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::Reservation>]
attr_accessor :items
# [Output Only] Type of resource.Always compute#reservationsList for listsof
# reservations
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::ReservationList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::ReservationList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class ReservationsResizeRequest
include Google::Apis::Core::Hashable
# Number of allocated resources can be resized with minimum = 1 and maximum =
# 1000.
# Corresponds to the JSON property `specificSkuCount`
# @return [Fixnum]
attr_accessor :specific_sku_count
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@specific_sku_count = args[:specific_sku_count] if args.key?(:specific_sku_count)
end
end
#
class ReservationsScopedList
include Google::Apis::Core::Hashable
# A list of reservations contained in this scope.
# Corresponds to the JSON property `reservations`
# @return [Array<Google::Apis::ComputeV1::Reservation>]
attr_accessor :reservations
# Informational warning which replaces the list of reservations when the list is
# empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::ReservationsScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@reservations = args[:reservations] if args.key?(:reservations)
@warning = args[:warning] if args.key?(:warning)
end
# Informational warning which replaces the list of reservations when the list is
# empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::ReservationsScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Commitment for a particular resource (a Commitment is composed of one or more
# of these).
class ResourceCommitment
include Google::Apis::Core::Hashable
# Name of the accelerator type resource. Applicable only when the type is
# ACCELERATOR.
# Corresponds to the JSON property `acceleratorType`
# @return [String]
attr_accessor :accelerator_type
# The amount of the resource purchased (in a type-dependent unit, such as bytes).
# For vCPUs, this can just be an integer. For memory, this must be provided in
# MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every
# vCPU.
# Corresponds to the JSON property `amount`
# @return [Fixnum]
attr_accessor :amount
# Type of resource for which this commitment applies. Possible values are VCPU
# and MEMORY
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@accelerator_type = args[:accelerator_type] if args.key?(:accelerator_type)
@amount = args[:amount] if args.key?(:amount)
@type = args[:type] if args.key?(:type)
end
end
#
class ResourceGroupReference
include Google::Apis::Core::Hashable
# A URI referencing one of the instance groups or network endpoint groups listed
# in the backend service.
# Corresponds to the JSON property `group`
# @return [String]
attr_accessor :group
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@group = args[:group] if args.key?(:group)
end
end
#
class ResourcePoliciesScopedList
include Google::Apis::Core::Hashable
# A list of resourcePolicies contained in this scope.
# Corresponds to the JSON property `resourcePolicies`
# @return [Array<Google::Apis::ComputeV1::ResourcePolicy>]
attr_accessor :resource_policies
# Informational warning which replaces the list of resourcePolicies when the
# list is empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::ResourcePoliciesScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@resource_policies = args[:resource_policies] if args.key?(:resource_policies)
@warning = args[:warning] if args.key?(:warning)
end
# Informational warning which replaces the list of resourcePolicies when the
# list is empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::ResourcePoliciesScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Represents a Resource Policy resource. You can use resource policies to
# schedule actions for some Compute Engine resources. For example, you can use
# them to schedule persistent disk snapshots.
# (== resource_for `$api_version`.resourcePolicies ==)
class ResourcePolicy
include Google::Apis::Core::Hashable
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
#
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# A GroupPlacementPolicy specifies resource placement configuration. It
# specifies the failure bucket separation as well as network locality
# Corresponds to the JSON property `groupPlacementPolicy`
# @return [Google::Apis::ComputeV1::ResourcePolicyGroupPlacementPolicy]
attr_accessor :group_placement_policy
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] Type of the resource. Always compute#resource_policies for
# resource policies.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
#
# Corresponds to the JSON property `region`
# @return [String]
attr_accessor :region
# [Output Only] Server-defined fully-qualified URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# A snapshot schedule policy specifies when and how frequently snapshots are to
# be created for the target disk. Also specifies how many and how long these
# scheduled snapshots should be retained.
# Corresponds to the JSON property `snapshotSchedulePolicy`
# @return [Google::Apis::ComputeV1::ResourcePolicySnapshotSchedulePolicy]
attr_accessor :snapshot_schedule_policy
# [Output Only] The status of resource policy creation.
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@group_placement_policy = args[:group_placement_policy] if args.key?(:group_placement_policy)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@region = args[:region] if args.key?(:region)
@self_link = args[:self_link] if args.key?(:self_link)
@snapshot_schedule_policy = args[:snapshot_schedule_policy] if args.key?(:snapshot_schedule_policy)
@status = args[:status] if args.key?(:status)
end
end
# Contains a list of resourcePolicies.
class ResourcePolicyAggregatedList
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `etag`
# @return [String]
attr_accessor :etag
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of ResourcePolicy resources.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::ResourcePoliciesScopedList>]
attr_accessor :items
# Type of resource.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::ResourcePolicyAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@etag = args[:etag] if args.key?(:etag)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::ResourcePolicyAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Time window specified for daily operations.
class ResourcePolicyDailyCycle
include Google::Apis::Core::Hashable
# Defines a schedule with units measured in months. The value determines how
# many months pass between the start of each cycle.
# Corresponds to the JSON property `daysInCycle`
# @return [Fixnum]
attr_accessor :days_in_cycle
# [Output only] A predetermined duration for the window, automatically chosen to
# be the smallest possible in the given scenario.
# Corresponds to the JSON property `duration`
# @return [String]
attr_accessor :duration
# Start time of the window. This must be in UTC format that resolves to one of
# 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:
# 00 are valid.
# Corresponds to the JSON property `startTime`
# @return [String]
attr_accessor :start_time
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@days_in_cycle = args[:days_in_cycle] if args.key?(:days_in_cycle)
@duration = args[:duration] if args.key?(:duration)
@start_time = args[:start_time] if args.key?(:start_time)
end
end
# A GroupPlacementPolicy specifies resource placement configuration. It
# specifies the failure bucket separation as well as network locality
class ResourcePolicyGroupPlacementPolicy
include Google::Apis::Core::Hashable
# The number of availability domains instances will be spread across. If two
# instances are in different availability domain, they will not be put in the
# same low latency network
# Corresponds to the JSON property `availabilityDomainCount`
# @return [Fixnum]
attr_accessor :availability_domain_count
# Specifies network collocation
# Corresponds to the JSON property `collocation`
# @return [String]
attr_accessor :collocation
# Number of vms in this placement group
# Corresponds to the JSON property `vmCount`
# @return [Fixnum]
attr_accessor :vm_count
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@availability_domain_count = args[:availability_domain_count] if args.key?(:availability_domain_count)
@collocation = args[:collocation] if args.key?(:collocation)
@vm_count = args[:vm_count] if args.key?(:vm_count)
end
end
# Time window specified for hourly operations.
class ResourcePolicyHourlyCycle
include Google::Apis::Core::Hashable
# [Output only] Duration of the time window, automatically chosen to be smallest
# possible in the given scenario.
# Corresponds to the JSON property `duration`
# @return [String]
attr_accessor :duration
# Defines a schedule with units measured in hours. The value determines how many
# hours pass between the start of each cycle.
# Corresponds to the JSON property `hoursInCycle`
# @return [Fixnum]
attr_accessor :hours_in_cycle
# Time within the window to start the operations. It must be in format "HH:MM",
# where HH : [00-23] and MM : [00-00] GMT.
# Corresponds to the JSON property `startTime`
# @return [String]
attr_accessor :start_time
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@duration = args[:duration] if args.key?(:duration)
@hours_in_cycle = args[:hours_in_cycle] if args.key?(:hours_in_cycle)
@start_time = args[:start_time] if args.key?(:start_time)
end
end
#
class ResourcePolicyList
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `etag`
# @return [String]
attr_accessor :etag
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# [Output Only] A list of ResourcePolicy resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::ResourcePolicy>]
attr_accessor :items
# [Output Only] Type of resource.Always compute#resourcePoliciesList for listsof
# resourcePolicies
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::ResourcePolicyList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@etag = args[:etag] if args.key?(:etag)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::ResourcePolicyList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# A snapshot schedule policy specifies when and how frequently snapshots are to
# be created for the target disk. Also specifies how many and how long these
# scheduled snapshots should be retained.
class ResourcePolicySnapshotSchedulePolicy
include Google::Apis::Core::Hashable
# Policy for retention of scheduled snapshots.
# Corresponds to the JSON property `retentionPolicy`
# @return [Google::Apis::ComputeV1::ResourcePolicySnapshotSchedulePolicyRetentionPolicy]
attr_accessor :retention_policy
# A schedule for disks where the schedueled operations are performed.
# Corresponds to the JSON property `schedule`
# @return [Google::Apis::ComputeV1::ResourcePolicySnapshotSchedulePolicySchedule]
attr_accessor :schedule
# Specified snapshot properties for scheduled snapshots created by this policy.
# Corresponds to the JSON property `snapshotProperties`
# @return [Google::Apis::ComputeV1::ResourcePolicySnapshotSchedulePolicySnapshotProperties]
attr_accessor :snapshot_properties
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@retention_policy = args[:retention_policy] if args.key?(:retention_policy)
@schedule = args[:schedule] if args.key?(:schedule)
@snapshot_properties = args[:snapshot_properties] if args.key?(:snapshot_properties)
end
end
# Policy for retention of scheduled snapshots.
class ResourcePolicySnapshotSchedulePolicyRetentionPolicy
include Google::Apis::Core::Hashable
# Maximum age of the snapshot that is allowed to be kept.
# Corresponds to the JSON property `maxRetentionDays`
# @return [Fixnum]
attr_accessor :max_retention_days
# Specifies the behavior to apply to scheduled snapshots when the source disk is
# deleted.
# Corresponds to the JSON property `onSourceDiskDelete`
# @return [String]
attr_accessor :on_source_disk_delete
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@max_retention_days = args[:max_retention_days] if args.key?(:max_retention_days)
@on_source_disk_delete = args[:on_source_disk_delete] if args.key?(:on_source_disk_delete)
end
end
# A schedule for disks where the schedueled operations are performed.
class ResourcePolicySnapshotSchedulePolicySchedule
include Google::Apis::Core::Hashable
# Time window specified for daily operations.
# Corresponds to the JSON property `dailySchedule`
# @return [Google::Apis::ComputeV1::ResourcePolicyDailyCycle]
attr_accessor :daily_schedule
# Time window specified for hourly operations.
# Corresponds to the JSON property `hourlySchedule`
# @return [Google::Apis::ComputeV1::ResourcePolicyHourlyCycle]
attr_accessor :hourly_schedule
# Time window specified for weekly operations.
# Corresponds to the JSON property `weeklySchedule`
# @return [Google::Apis::ComputeV1::ResourcePolicyWeeklyCycle]
attr_accessor :weekly_schedule
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@daily_schedule = args[:daily_schedule] if args.key?(:daily_schedule)
@hourly_schedule = args[:hourly_schedule] if args.key?(:hourly_schedule)
@weekly_schedule = args[:weekly_schedule] if args.key?(:weekly_schedule)
end
end
# Specified snapshot properties for scheduled snapshots created by this policy.
class ResourcePolicySnapshotSchedulePolicySnapshotProperties
include Google::Apis::Core::Hashable
# Indication to perform a 'guest aware' snapshot.
# Corresponds to the JSON property `guestFlush`
# @return [Boolean]
attr_accessor :guest_flush
alias_method :guest_flush?, :guest_flush
# Labels to apply to scheduled snapshots. These can be later modified by the
# setLabels method. Label values may be empty.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
# Cloud Storage bucket storage location of the auto snapshot (regional or multi-
# regional).
# Corresponds to the JSON property `storageLocations`
# @return [Array<String>]
attr_accessor :storage_locations
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@guest_flush = args[:guest_flush] if args.key?(:guest_flush)
@labels = args[:labels] if args.key?(:labels)
@storage_locations = args[:storage_locations] if args.key?(:storage_locations)
end
end
# Time window specified for weekly operations.
class ResourcePolicyWeeklyCycle
include Google::Apis::Core::Hashable
# Up to 7 intervals/windows, one for each day of the week.
# Corresponds to the JSON property `dayOfWeeks`
# @return [Array<Google::Apis::ComputeV1::ResourcePolicyWeeklyCycleDayOfWeek>]
attr_accessor :day_of_weeks
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@day_of_weeks = args[:day_of_weeks] if args.key?(:day_of_weeks)
end
end
#
class ResourcePolicyWeeklyCycleDayOfWeek
include Google::Apis::Core::Hashable
# Defines a schedule that runs on specific days of the week. Specify one or more
# days. The following options are available: MONDAY, TUESDAY, WEDNESDAY,
# THURSDAY, FRIDAY, SATURDAY, SUNDAY.
# Corresponds to the JSON property `day`
# @return [String]
attr_accessor :day
# [Output only] Duration of the time window, automatically chosen to be smallest
# possible in the given scenario.
# Corresponds to the JSON property `duration`
# @return [String]
attr_accessor :duration
# Time within the window to start the operations. It must be in format "HH:MM",
# where HH : [00-23] and MM : [00-00] GMT.
# Corresponds to the JSON property `startTime`
# @return [String]
attr_accessor :start_time
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@day = args[:day] if args.key?(:day)
@duration = args[:duration] if args.key?(:duration)
@start_time = args[:start_time] if args.key?(:start_time)
end
end
# Represents a Route resource.
# A route defines a path from VM instances in the VPC network to a specific
# destination. This destination can be inside or outside the VPC network. For
# more information, read the Routes overview. (== resource_for `$api_version`.
# routes ==)
class Route
include Google::Apis::Core::Hashable
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this field when you create
# the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# The destination range of outgoing packets that this route applies to. Only
# IPv4 is supported.
# Corresponds to the JSON property `destRange`
# @return [String]
attr_accessor :dest_range
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] Type of this resource. Always compute#routes for Route resources.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# 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])?`. The first character must be a lowercase letter, and all
# following characters (except for the last character) must be a dash, lowercase
# letter, or digit. The last character must be a lowercase letter or digit.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Fully-qualified URL of the network that this route applies to.
# Corresponds to the JSON property `network`
# @return [String]
attr_accessor :network
# The URL to a gateway that should handle matching packets. You can only specify
# the internet gateway using a full or partial valid URL: projects/project/
# global/gateways/default-internet-gateway
# Corresponds to the JSON property `nextHopGateway`
# @return [String]
attr_accessor :next_hop_gateway
# The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should
# handle matching packets. You can only specify the forwarding rule as a partial
# or full URL. For example, the following are all valid URLs:
# - https://www.googleapis.com/compute/v1/projects/project/regions/region/
# forwardingRules/forwardingRule
# - regions/region/forwardingRules/forwardingRule
# Corresponds to the JSON property `nextHopIlb`
# @return [String]
attr_accessor :next_hop_ilb
# The URL to an instance that should handle matching packets. You can specify
# this as a full or partial URL. For example:
# https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
# Corresponds to the JSON property `nextHopInstance`
# @return [String]
attr_accessor :next_hop_instance
# The network IP address of an instance that should handle matching packets.
# Only IPv4 is supported.
# Corresponds to the JSON property `nextHopIp`
# @return [String]
attr_accessor :next_hop_ip
# The URL of the local network if it should handle matching packets.
# Corresponds to the JSON property `nextHopNetwork`
# @return [String]
attr_accessor :next_hop_network
# [Output Only] The network peering name that should handle matching packets,
# which should conform to RFC1035.
# Corresponds to the JSON property `nextHopPeering`
# @return [String]
attr_accessor :next_hop_peering
# The URL to a VpnTunnel that should handle matching packets.
# Corresponds to the JSON property `nextHopVpnTunnel`
# @return [String]
attr_accessor :next_hop_vpn_tunnel
# The priority of this route. Priority is used to break ties in cases where
# there is more than one matching route of equal prefix length. In cases where
# multiple routes have equal prefix length, the one with the lowest-numbered
# priority value wins. The default value is `1000`. The priority value must be
# from `0` to `65535`, inclusive.
# Corresponds to the JSON property `priority`
# @return [Fixnum]
attr_accessor :priority
# [Output Only] Server-defined fully-qualified URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# A list of instance tags to which this route applies.
# Corresponds to the JSON property `tags`
# @return [Array<String>]
attr_accessor :tags
# [Output Only] If potential misconfigurations are detected for this route, this
# field will be populated with warning messages.
# Corresponds to the JSON property `warnings`
# @return [Array<Google::Apis::ComputeV1::Route::Warning>]
attr_accessor :warnings
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@dest_range = args[:dest_range] if args.key?(:dest_range)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@network = args[:network] if args.key?(:network)
@next_hop_gateway = args[:next_hop_gateway] if args.key?(:next_hop_gateway)
@next_hop_ilb = args[:next_hop_ilb] if args.key?(:next_hop_ilb)
@next_hop_instance = args[:next_hop_instance] if args.key?(:next_hop_instance)
@next_hop_ip = args[:next_hop_ip] if args.key?(:next_hop_ip)
@next_hop_network = args[:next_hop_network] if args.key?(:next_hop_network)
@next_hop_peering = args[:next_hop_peering] if args.key?(:next_hop_peering)
@next_hop_vpn_tunnel = args[:next_hop_vpn_tunnel] if args.key?(:next_hop_vpn_tunnel)
@priority = args[:priority] if args.key?(:priority)
@self_link = args[:self_link] if args.key?(:self_link)
@tags = args[:tags] if args.key?(:tags)
@warnings = args[:warnings] if args.key?(:warnings)
end
#
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::Route::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Contains a list of Route resources.
class RouteList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of Route resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::Route>]
attr_accessor :items
# Type of resource.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::RouteList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::RouteList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Represents a Cloud Router resource.
# For more information about Cloud Router, read the Cloud Router overview.
class Router
include Google::Apis::Core::Hashable
# BGP information specific to this router.
# Corresponds to the JSON property `bgp`
# @return [Google::Apis::ComputeV1::RouterBgp]
attr_accessor :bgp
# BGP information that must be configured into the routing stack to establish
# BGP peering. This information must specify the peer ASN and either the
# interface name, IP address, or peer IP address. Please refer to RFC4273.
# Corresponds to the JSON property `bgpPeers`
# @return [Array<Google::Apis::ComputeV1::RouterBgpPeer>]
attr_accessor :bgp_peers
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# Router interfaces. Each interface requires either one linked resource, (for
# example, linkedVpnTunnel), or IP address and IP address range (for example,
# ipRange), or both.
# Corresponds to the JSON property `interfaces`
# @return [Array<Google::Apis::ComputeV1::RouterInterface>]
attr_accessor :interfaces
# [Output Only] Type of resource. Always compute#router for routers.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# A list of NAT services created in this router.
# Corresponds to the JSON property `nats`
# @return [Array<Google::Apis::ComputeV1::RouterNat>]
attr_accessor :nats
# URI of the network to which this router belongs.
# Corresponds to the JSON property `network`
# @return [String]
attr_accessor :network
# [Output Only] URI of the region where the router resides. You must specify
# this field as part of the HTTP request URL. It is not settable as a field in
# the request body.
# Corresponds to the JSON property `region`
# @return [String]
attr_accessor :region
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@bgp = args[:bgp] if args.key?(:bgp)
@bgp_peers = args[:bgp_peers] if args.key?(:bgp_peers)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@id = args[:id] if args.key?(:id)
@interfaces = args[:interfaces] if args.key?(:interfaces)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@nats = args[:nats] if args.key?(:nats)
@network = args[:network] if args.key?(:network)
@region = args[:region] if args.key?(:region)
@self_link = args[:self_link] if args.key?(:self_link)
end
end
# Description-tagged IP ranges for the router to advertise.
class RouterAdvertisedIpRange
include Google::Apis::Core::Hashable
# User-specified description for the IP range.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# The IP range to advertise. The value must be a CIDR-formatted string.
# Corresponds to the JSON property `range`
# @return [String]
attr_accessor :range
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@description = args[:description] if args.key?(:description)
@range = args[:range] if args.key?(:range)
end
end
# Contains a list of routers.
class RouterAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of Router resources.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::RoutersScopedList>]
attr_accessor :items
# Type of resource.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::RouterAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::RouterAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class RouterBgp
include Google::Apis::Core::Hashable
# User-specified flag to indicate which mode to use for advertisement. The
# options are DEFAULT or CUSTOM.
# Corresponds to the JSON property `advertiseMode`
# @return [String]
attr_accessor :advertise_mode
# User-specified list of prefix groups to advertise in custom mode. This field
# can only be populated if advertise_mode is CUSTOM and is advertised to all
# peers of the router. These groups will be advertised in addition to any
# specified prefixes. Leave this field blank to advertise no custom groups.
# Corresponds to the JSON property `advertisedGroups`
# @return [Array<String>]
attr_accessor :advertised_groups
# User-specified list of individual IP ranges to advertise in custom mode. This
# field can only be populated if advertise_mode is CUSTOM and is advertised to
# all peers of the router. These IP ranges will be advertised in addition to any
# specified groups. Leave this field blank to advertise no custom IP ranges.
# Corresponds to the JSON property `advertisedIpRanges`
# @return [Array<Google::Apis::ComputeV1::RouterAdvertisedIpRange>]
attr_accessor :advertised_ip_ranges
# Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN,
# either 16-bit or 32-bit. The value will be fixed for this router resource. All
# VPN tunnels that link to this router will have the same local ASN.
# Corresponds to the JSON property `asn`
# @return [Fixnum]
attr_accessor :asn
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@advertise_mode = args[:advertise_mode] if args.key?(:advertise_mode)
@advertised_groups = args[:advertised_groups] if args.key?(:advertised_groups)
@advertised_ip_ranges = args[:advertised_ip_ranges] if args.key?(:advertised_ip_ranges)
@asn = args[:asn] if args.key?(:asn)
end
end
#
class RouterBgpPeer
include Google::Apis::Core::Hashable
# User-specified flag to indicate which mode to use for advertisement.
# Corresponds to the JSON property `advertiseMode`
# @return [String]
attr_accessor :advertise_mode
# User-specified list of prefix groups to advertise in custom mode, which can
# take one of the following options:
# - ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets.
# - ALL_VPC_SUBNETS: Advertises the router's own VPC subnets.
# - ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network.
# Note that this field can only be populated if advertise_mode is CUSTOM and
# overrides the list defined for the router (in the "bgp" message). These groups
# are advertised in addition to any specified prefixes. Leave this field blank
# to advertise no custom groups.
# Corresponds to the JSON property `advertisedGroups`
# @return [Array<String>]
attr_accessor :advertised_groups
# User-specified list of individual IP ranges to advertise in custom mode. This
# field can only be populated if advertise_mode is CUSTOM and overrides the list
# defined for the router (in the "bgp" message). These IP ranges are advertised
# in addition to any specified groups. Leave this field blank to advertise no
# custom IP ranges.
# Corresponds to the JSON property `advertisedIpRanges`
# @return [Array<Google::Apis::ComputeV1::RouterAdvertisedIpRange>]
attr_accessor :advertised_ip_ranges
# The priority of routes advertised to this BGP peer. Where there is more than
# one matching route of maximum length, the routes with the lowest priority
# value win.
# Corresponds to the JSON property `advertisedRoutePriority`
# @return [Fixnum]
attr_accessor :advertised_route_priority
# Name of the interface the BGP peer is associated with.
# Corresponds to the JSON property `interfaceName`
# @return [String]
attr_accessor :interface_name
# IP address of the interface inside Google Cloud Platform. Only IPv4 is
# supported.
# Corresponds to the JSON property `ipAddress`
# @return [String]
attr_accessor :ip_address
# [Output Only] The resource that configures and manages this BGP peer.
# - MANAGED_BY_USER is the default value and can be managed by you or other
# users
# - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud
# Interconnect, specifically by an InterconnectAttachment of type PARTNER.
# Google automatically creates, updates, and deletes this type of BGP peer when
# the PARTNER InterconnectAttachment is created, updated, or deleted.
# Corresponds to the JSON property `managementType`
# @return [String]
attr_accessor :management_type
# Name of this BGP peer. 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Peer BGP Autonomous System Number (ASN). Each BGP interface may use a
# different value.
# Corresponds to the JSON property `peerAsn`
# @return [Fixnum]
attr_accessor :peer_asn
# IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is
# supported.
# Corresponds to the JSON property `peerIpAddress`
# @return [String]
attr_accessor :peer_ip_address
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@advertise_mode = args[:advertise_mode] if args.key?(:advertise_mode)
@advertised_groups = args[:advertised_groups] if args.key?(:advertised_groups)
@advertised_ip_ranges = args[:advertised_ip_ranges] if args.key?(:advertised_ip_ranges)
@advertised_route_priority = args[:advertised_route_priority] if args.key?(:advertised_route_priority)
@interface_name = args[:interface_name] if args.key?(:interface_name)
@ip_address = args[:ip_address] if args.key?(:ip_address)
@management_type = args[:management_type] if args.key?(:management_type)
@name = args[:name] if args.key?(:name)
@peer_asn = args[:peer_asn] if args.key?(:peer_asn)
@peer_ip_address = args[:peer_ip_address] if args.key?(:peer_ip_address)
end
end
#
class RouterInterface
include Google::Apis::Core::Hashable
# IP address and range of the interface. The IP range must be in the RFC3927
# link-local IP address space. The value must be a CIDR-formatted string, for
# example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents
# the IP address of the interface.
# Corresponds to the JSON property `ipRange`
# @return [String]
attr_accessor :ip_range
# URI of the linked Interconnect attachment. It must be in the same region as
# the router. Each interface can have one linked resource, which can be a VPN
# tunnel, an Interconnect attachment, or a virtual machine instance.
# Corresponds to the JSON property `linkedInterconnectAttachment`
# @return [String]
attr_accessor :linked_interconnect_attachment
# URI of the linked VPN tunnel, which must be in the same region as the router.
# Each interface can have one linked resource, which can be a VPN tunnel, an
# Interconnect attachment, or a virtual machine instance.
# Corresponds to the JSON property `linkedVpnTunnel`
# @return [String]
attr_accessor :linked_vpn_tunnel
# [Output Only] The resource that configures and manages this interface.
# - MANAGED_BY_USER is the default value and can be managed directly by users.
# - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by
# Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER.
# Google automatically creates, updates, and deletes this type of interface
# when the PARTNER InterconnectAttachment is created, updated, or deleted.
# Corresponds to the JSON property `managementType`
# @return [String]
attr_accessor :management_type
# Name of this interface entry. 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@ip_range = args[:ip_range] if args.key?(:ip_range)
@linked_interconnect_attachment = args[:linked_interconnect_attachment] if args.key?(:linked_interconnect_attachment)
@linked_vpn_tunnel = args[:linked_vpn_tunnel] if args.key?(:linked_vpn_tunnel)
@management_type = args[:management_type] if args.key?(:management_type)
@name = args[:name] if args.key?(:name)
end
end
# Contains a list of Router resources.
class RouterList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of Router resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::Router>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#router for routers.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::RouterList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::RouterList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Represents a Nat resource. It enables the VMs within the specified subnetworks
# to access Internet without external IP addresses. It specifies a list of
# subnetworks (and the ranges within) that want to use NAT. Customers can also
# provide the external IPs that would be used for NAT. GCP would auto-allocate
# ephemeral IPs if no external IPs are provided.
class RouterNat
include Google::Apis::Core::Hashable
# A list of URLs of the IP resources to be drained. These IPs must be valid
# static external IPs that have been assigned to the NAT. These IPs should be
# used for updating/patching a NAT only.
# Corresponds to the JSON property `drainNatIps`
# @return [Array<String>]
attr_accessor :drain_nat_ips
# Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.
# Corresponds to the JSON property `icmpIdleTimeoutSec`
# @return [Fixnum]
attr_accessor :icmp_idle_timeout_sec
# Configuration of logging on a NAT.
# Corresponds to the JSON property `logConfig`
# @return [Google::Apis::ComputeV1::RouterNatLogConfig]
attr_accessor :log_config
# Minimum number of ports allocated to a VM from this NAT config. If not set, a
# default number of ports is allocated to a VM. This is rounded up to the
# nearest power of 2. For example, if the value of this field is 50, at least 64
# ports are allocated to a VM.
# Corresponds to the JSON property `minPortsPerVm`
# @return [Fixnum]
attr_accessor :min_ports_per_vm
# Unique name of this Nat service. The name must be 1-63 characters long and
# comply with RFC1035.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Specify the NatIpAllocateOption, which can take one of the following values:
# - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there
# are not enough specified Nat IPs, the Nat service fails for new VMs.
# - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't
# specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty.
# Corresponds to the JSON property `natIpAllocateOption`
# @return [String]
attr_accessor :nat_ip_allocate_option
# A list of URLs of the IP resources used for this Nat service. These IP
# addresses must be valid static external IP addresses assigned to the project.
# Corresponds to the JSON property `natIps`
# @return [Array<String>]
attr_accessor :nat_ips
# Specify the Nat option, which can take one of the following values:
# - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are
# allowed to Nat.
# - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every
# Subnetwork are allowed to Nat.
# - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in
# the field subnetwork below) The default is
# SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field
# contains ALL_SUBNETWORKS_ALL_IP_RANGES or
# ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other
# Router.Nat section in any Router for this network in this region.
# Corresponds to the JSON property `sourceSubnetworkIpRangesToNat`
# @return [String]
attr_accessor :source_subnetwork_ip_ranges_to_nat
# A list of Subnetwork resources whose traffic should be translated by NAT
# Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the
# SubnetworkIpRangeToNatOption above.
# Corresponds to the JSON property `subnetworks`
# @return [Array<Google::Apis::ComputeV1::RouterNatSubnetworkToNat>]
attr_accessor :subnetworks
# Timeout (in seconds) for TCP established connections. Defaults to 1200s if not
# set.
# Corresponds to the JSON property `tcpEstablishedIdleTimeoutSec`
# @return [Fixnum]
attr_accessor :tcp_established_idle_timeout_sec
# Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not
# set.
# Corresponds to the JSON property `tcpTransitoryIdleTimeoutSec`
# @return [Fixnum]
attr_accessor :tcp_transitory_idle_timeout_sec
# Timeout (in seconds) for UDP connections. Defaults to 30s if not set.
# Corresponds to the JSON property `udpIdleTimeoutSec`
# @return [Fixnum]
attr_accessor :udp_idle_timeout_sec
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@drain_nat_ips = args[:drain_nat_ips] if args.key?(:drain_nat_ips)
@icmp_idle_timeout_sec = args[:icmp_idle_timeout_sec] if args.key?(:icmp_idle_timeout_sec)
@log_config = args[:log_config] if args.key?(:log_config)
@min_ports_per_vm = args[:min_ports_per_vm] if args.key?(:min_ports_per_vm)
@name = args[:name] if args.key?(:name)
@nat_ip_allocate_option = args[:nat_ip_allocate_option] if args.key?(:nat_ip_allocate_option)
@nat_ips = args[:nat_ips] if args.key?(:nat_ips)
@source_subnetwork_ip_ranges_to_nat = args[:source_subnetwork_ip_ranges_to_nat] if args.key?(:source_subnetwork_ip_ranges_to_nat)
@subnetworks = args[:subnetworks] if args.key?(:subnetworks)
@tcp_established_idle_timeout_sec = args[:tcp_established_idle_timeout_sec] if args.key?(:tcp_established_idle_timeout_sec)
@tcp_transitory_idle_timeout_sec = args[:tcp_transitory_idle_timeout_sec] if args.key?(:tcp_transitory_idle_timeout_sec)
@udp_idle_timeout_sec = args[:udp_idle_timeout_sec] if args.key?(:udp_idle_timeout_sec)
end
end
# Configuration of logging on a NAT.
class RouterNatLogConfig
include Google::Apis::Core::Hashable
# Indicates whether or not to export logs. This is false by default.
# Corresponds to the JSON property `enable`
# @return [Boolean]
attr_accessor :enable
alias_method :enable?, :enable
# Specify the desired filtering of logs on this NAT. If unspecified, logs are
# exported for all connections handled by this NAT. This option can take one of
# the following values:
# - ERRORS_ONLY: Export logs only for connection failures.
# - TRANSLATIONS_ONLY: Export logs only for successful connections.
# - ALL: Export logs for all connections, successful and unsuccessful.
# Corresponds to the JSON property `filter`
# @return [String]
attr_accessor :filter
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@enable = args[:enable] if args.key?(:enable)
@filter = args[:filter] if args.key?(:filter)
end
end
# Defines the IP ranges that want to use NAT for a subnetwork.
class RouterNatSubnetworkToNat
include Google::Apis::Core::Hashable
# URL for the subnetwork resource that will use NAT.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# A list of the secondary ranges of the Subnetwork that are allowed to use NAT.
# This can be populated only if "LIST_OF_SECONDARY_IP_RANGES" is one of the
# values in source_ip_ranges_to_nat.
# Corresponds to the JSON property `secondaryIpRangeNames`
# @return [Array<String>]
attr_accessor :secondary_ip_range_names
# Specify the options for NAT ranges in the Subnetwork. All options of a single
# value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option
# with multiple values is: ["PRIMARY_IP_RANGE", "LIST_OF_SECONDARY_IP_RANGES"]
# Default: [ALL_IP_RANGES]
# Corresponds to the JSON property `sourceIpRangesToNat`
# @return [Array<String>]
attr_accessor :source_ip_ranges_to_nat
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@name = args[:name] if args.key?(:name)
@secondary_ip_range_names = args[:secondary_ip_range_names] if args.key?(:secondary_ip_range_names)
@source_ip_ranges_to_nat = args[:source_ip_ranges_to_nat] if args.key?(:source_ip_ranges_to_nat)
end
end
#
class RouterStatus
include Google::Apis::Core::Hashable
# Best routes for this router's network.
# Corresponds to the JSON property `bestRoutes`
# @return [Array<Google::Apis::ComputeV1::Route>]
attr_accessor :best_routes
# Best routes learned by this router.
# Corresponds to the JSON property `bestRoutesForRouter`
# @return [Array<Google::Apis::ComputeV1::Route>]
attr_accessor :best_routes_for_router
#
# Corresponds to the JSON property `bgpPeerStatus`
# @return [Array<Google::Apis::ComputeV1::RouterStatusBgpPeerStatus>]
attr_accessor :bgp_peer_status
#
# Corresponds to the JSON property `natStatus`
# @return [Array<Google::Apis::ComputeV1::RouterStatusNatStatus>]
attr_accessor :nat_status
# URI of the network to which this router belongs.
# Corresponds to the JSON property `network`
# @return [String]
attr_accessor :network
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@best_routes = args[:best_routes] if args.key?(:best_routes)
@best_routes_for_router = args[:best_routes_for_router] if args.key?(:best_routes_for_router)
@bgp_peer_status = args[:bgp_peer_status] if args.key?(:bgp_peer_status)
@nat_status = args[:nat_status] if args.key?(:nat_status)
@network = args[:network] if args.key?(:network)
end
end
#
class RouterStatusBgpPeerStatus
include Google::Apis::Core::Hashable
# Routes that were advertised to the remote BGP peer
# Corresponds to the JSON property `advertisedRoutes`
# @return [Array<Google::Apis::ComputeV1::Route>]
attr_accessor :advertised_routes
# IP address of the local BGP interface.
# Corresponds to the JSON property `ipAddress`
# @return [String]
attr_accessor :ip_address
# URL of the VPN tunnel that this BGP peer controls.
# Corresponds to the JSON property `linkedVpnTunnel`
# @return [String]
attr_accessor :linked_vpn_tunnel
# Name of this BGP peer. Unique within the Routers resource.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Number of routes learned from the remote BGP Peer.
# Corresponds to the JSON property `numLearnedRoutes`
# @return [Fixnum]
attr_accessor :num_learned_routes
# IP address of the remote BGP interface.
# Corresponds to the JSON property `peerIpAddress`
# @return [String]
attr_accessor :peer_ip_address
# BGP state as specified in RFC1771.
# Corresponds to the JSON property `state`
# @return [String]
attr_accessor :state
# Status of the BGP peer: `UP, DOWN`
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
# Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours,
# 59 minutes, 59 seconds
# Corresponds to the JSON property `uptime`
# @return [String]
attr_accessor :uptime
# Time this session has been up, in seconds. Format: 145
# Corresponds to the JSON property `uptimeSeconds`
# @return [String]
attr_accessor :uptime_seconds
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@advertised_routes = args[:advertised_routes] if args.key?(:advertised_routes)
@ip_address = args[:ip_address] if args.key?(:ip_address)
@linked_vpn_tunnel = args[:linked_vpn_tunnel] if args.key?(:linked_vpn_tunnel)
@name = args[:name] if args.key?(:name)
@num_learned_routes = args[:num_learned_routes] if args.key?(:num_learned_routes)
@peer_ip_address = args[:peer_ip_address] if args.key?(:peer_ip_address)
@state = args[:state] if args.key?(:state)
@status = args[:status] if args.key?(:status)
@uptime = args[:uptime] if args.key?(:uptime)
@uptime_seconds = args[:uptime_seconds] if args.key?(:uptime_seconds)
end
end
# Status of a NAT contained in this router.
class RouterStatusNatStatus
include Google::Apis::Core::Hashable
# A list of IPs auto-allocated for NAT. Example: ["1.1.1.1", "129.2.16.89"]
# Corresponds to the JSON property `autoAllocatedNatIps`
# @return [Array<String>]
attr_accessor :auto_allocated_nat_ips
# A list of IPs auto-allocated for NAT that are in drain mode. Example: ["1.1.1.
# 1", "179.12.26.133"].
# Corresponds to the JSON property `drainAutoAllocatedNatIps`
# @return [Array<String>]
attr_accessor :drain_auto_allocated_nat_ips
# A list of IPs user-allocated for NAT that are in drain mode. Example: ["1.1.1.
# 1", "179.12.26.133"].
# Corresponds to the JSON property `drainUserAllocatedNatIps`
# @return [Array<String>]
attr_accessor :drain_user_allocated_nat_ips
# The number of extra IPs to allocate. This will be greater than 0 only if user-
# specified IPs are NOT enough to allow all configured VMs to use NAT. This
# value is meaningful only when auto-allocation of NAT IPs is *not* used.
# Corresponds to the JSON property `minExtraNatIpsNeeded`
# @return [Fixnum]
attr_accessor :min_extra_nat_ips_needed
# Unique name of this NAT.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Number of VM endpoints (i.e., Nics) that can use NAT.
# Corresponds to the JSON property `numVmEndpointsWithNatMappings`
# @return [Fixnum]
attr_accessor :num_vm_endpoints_with_nat_mappings
# A list of fully qualified URLs of reserved IP address resources.
# Corresponds to the JSON property `userAllocatedNatIpResources`
# @return [Array<String>]
attr_accessor :user_allocated_nat_ip_resources
# A list of IPs user-allocated for NAT. They will be raw IP strings like "179.12.
# 26.133".
# Corresponds to the JSON property `userAllocatedNatIps`
# @return [Array<String>]
attr_accessor :user_allocated_nat_ips
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@auto_allocated_nat_ips = args[:auto_allocated_nat_ips] if args.key?(:auto_allocated_nat_ips)
@drain_auto_allocated_nat_ips = args[:drain_auto_allocated_nat_ips] if args.key?(:drain_auto_allocated_nat_ips)
@drain_user_allocated_nat_ips = args[:drain_user_allocated_nat_ips] if args.key?(:drain_user_allocated_nat_ips)
@min_extra_nat_ips_needed = args[:min_extra_nat_ips_needed] if args.key?(:min_extra_nat_ips_needed)
@name = args[:name] if args.key?(:name)
@num_vm_endpoints_with_nat_mappings = args[:num_vm_endpoints_with_nat_mappings] if args.key?(:num_vm_endpoints_with_nat_mappings)
@user_allocated_nat_ip_resources = args[:user_allocated_nat_ip_resources] if args.key?(:user_allocated_nat_ip_resources)
@user_allocated_nat_ips = args[:user_allocated_nat_ips] if args.key?(:user_allocated_nat_ips)
end
end
#
class RouterStatusResponse
include Google::Apis::Core::Hashable
# Type of resource.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
#
# Corresponds to the JSON property `result`
# @return [Google::Apis::ComputeV1::RouterStatus]
attr_accessor :result
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@kind = args[:kind] if args.key?(:kind)
@result = args[:result] if args.key?(:result)
end
end
#
class RoutersPreviewResponse
include Google::Apis::Core::Hashable
# Represents a Cloud Router resource.
# For more information about Cloud Router, read the Cloud Router overview.
# Corresponds to the JSON property `resource`
# @return [Google::Apis::ComputeV1::Router]
attr_accessor :resource
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@resource = args[:resource] if args.key?(:resource)
end
end
#
class RoutersScopedList
include Google::Apis::Core::Hashable
# A list of routers contained in this scope.
# Corresponds to the JSON property `routers`
# @return [Array<Google::Apis::ComputeV1::Router>]
attr_accessor :routers
# Informational warning which replaces the list of routers when the list is
# empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::RoutersScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@routers = args[:routers] if args.key?(:routers)
@warning = args[:warning] if args.key?(:warning)
end
# Informational warning which replaces the list of routers when the list is
# empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::RoutersScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# A rule to be applied in a Policy.
class Rule
include Google::Apis::Core::Hashable
# Required
# Corresponds to the JSON property `action`
# @return [String]
attr_accessor :action
# Additional restrictions that must be met. All conditions must pass for the
# rule to match.
# Corresponds to the JSON property `conditions`
# @return [Array<Google::Apis::ComputeV1::Condition>]
attr_accessor :conditions
# Human-readable description of the rule.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/
# AUTHORITY_SELECTOR is in at least one of these entries.
# Corresponds to the JSON property `ins`
# @return [Array<String>]
attr_accessor :ins
# The config returned to callers of tech.iam.IAM.CheckPolicy for any entries
# that match the LOG action.
# Corresponds to the JSON property `logConfigs`
# @return [Array<Google::Apis::ComputeV1::LogConfig>]
attr_accessor :log_configs
# If one or more 'not_in' clauses are specified, the rule matches if the
# PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.
# Corresponds to the JSON property `notIns`
# @return [Array<String>]
attr_accessor :not_ins
# A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value
# of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.
# *') matches all verbs.
# Corresponds to the JSON property `permissions`
# @return [Array<String>]
attr_accessor :permissions
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@action = args[:action] if args.key?(:action)
@conditions = args[:conditions] if args.key?(:conditions)
@description = args[:description] if args.key?(:description)
@ins = args[:ins] if args.key?(:ins)
@log_configs = args[:log_configs] if args.key?(:log_configs)
@not_ins = args[:not_ins] if args.key?(:not_ins)
@permissions = args[:permissions] if args.key?(:permissions)
end
end
#
class SslHealthCheck
include Google::Apis::Core::Hashable
# The TCP port number for the health check request. The default value is 443.
# Valid values are 1 through 65535.
# Corresponds to the JSON property `port`
# @return [Fixnum]
attr_accessor :port
# Port name as defined in InstanceGroup#NamedPort#name. If both port and
# port_name are defined, port takes precedence.
# Corresponds to the JSON property `portName`
# @return [String]
attr_accessor :port_name
# Specifies how port is selected for health checking, can be one of following
# values:
# USE_FIXED_PORT: The port number in port is used for health checking.
# USE_NAMED_PORT: The portName is used for health checking.
# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each
# network endpoint is used for health checking. For other backends, the port or
# named port specified in the Backend Service is used for health checking.
# If not specified, SSL health check follows behavior specified in port and
# portName fields.
# Corresponds to the JSON property `portSpecification`
# @return [String]
attr_accessor :port_specification
# Specifies the type of proxy header to append before sending data to the
# backend, either NONE or PROXY_V1. The default is NONE.
# Corresponds to the JSON property `proxyHeader`
# @return [String]
attr_accessor :proxy_header
# The application data to send once the SSL connection has been established (
# default value is empty). If both request and response are empty, the
# connection establishment alone will indicate health. The request data can only
# be ASCII.
# Corresponds to the JSON property `request`
# @return [String]
attr_accessor :request
# The bytes to match against the beginning of the response data. If left empty (
# the default value), any response will indicate health. The response data can
# only be ASCII.
# Corresponds to the JSON property `response`
# @return [String]
attr_accessor :response
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@port = args[:port] if args.key?(:port)
@port_name = args[:port_name] if args.key?(:port_name)
@port_specification = args[:port_specification] if args.key?(:port_specification)
@proxy_header = args[:proxy_header] if args.key?(:proxy_header)
@request = args[:request] if args.key?(:request)
@response = args[:response] if args.key?(:response)
end
end
# Sets the scheduling options for an Instance. NextID: 12
class Scheduling
include Google::Apis::Core::Hashable
# Specifies whether the instance should be automatically restarted if it is
# terminated by Compute Engine (not terminated by a user). You can only set the
# automatic restart option for standard instances. Preemptible instances cannot
# be automatically restarted.
# By default, this is set to true so an instance is automatically restarted if
# it is terminated by Compute Engine.
# Corresponds to the JSON property `automaticRestart`
# @return [Boolean]
attr_accessor :automatic_restart
alias_method :automatic_restart?, :automatic_restart
# A set of node affinity and anti-affinity configurations. Refer to Configuring
# node affinity for more information. Overrides reservationAffinity.
# Corresponds to the JSON property `nodeAffinities`
# @return [Array<Google::Apis::ComputeV1::SchedulingNodeAffinity>]
attr_accessor :node_affinities
# Defines the maintenance behavior for this instance. For standard instances,
# the default behavior is MIGRATE. For preemptible instances, the default and
# only possible behavior is TERMINATE. For more information, see Setting
# Instance Scheduling Options.
# Corresponds to the JSON property `onHostMaintenance`
# @return [String]
attr_accessor :on_host_maintenance
# Defines whether the instance is preemptible. This can only be set during
# instance creation or while the instance is stopped and therefore, in a `
# TERMINATED` state. See Instance Life Cycle for more information on the
# possible instance states.
# Corresponds to the JSON property `preemptible`
# @return [Boolean]
attr_accessor :preemptible
alias_method :preemptible?, :preemptible
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@automatic_restart = args[:automatic_restart] if args.key?(:automatic_restart)
@node_affinities = args[:node_affinities] if args.key?(:node_affinities)
@on_host_maintenance = args[:on_host_maintenance] if args.key?(:on_host_maintenance)
@preemptible = args[:preemptible] if args.key?(:preemptible)
end
end
# Node Affinity: the configuration of desired nodes onto which this Instance
# could be scheduled.
class SchedulingNodeAffinity
include Google::Apis::Core::Hashable
# Corresponds to the label key of Node resource.
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# Defines the operation of node selection. Valid operators are IN for affinity
# and NOT_IN for anti-affinity.
# Corresponds to the JSON property `operator`
# @return [String]
attr_accessor :operator
# Corresponds to the label values of Node resource.
# Corresponds to the JSON property `values`
# @return [Array<String>]
attr_accessor :values
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@operator = args[:operator] if args.key?(:operator)
@values = args[:values] if args.key?(:values)
end
end
#
class SecurityPoliciesListPreconfiguredExpressionSetsResponse
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `preconfiguredExpressionSets`
# @return [Google::Apis::ComputeV1::SecurityPoliciesWafConfig]
attr_accessor :preconfigured_expression_sets
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@preconfigured_expression_sets = args[:preconfigured_expression_sets] if args.key?(:preconfigured_expression_sets)
end
end
#
class SecurityPoliciesWafConfig
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `wafRules`
# @return [Google::Apis::ComputeV1::PreconfiguredWafSet]
attr_accessor :waf_rules
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@waf_rules = args[:waf_rules] if args.key?(:waf_rules)
end
end
# Represents a Cloud Armor Security Policy resource.
# Only external backend services that use load balancers can reference a
# Security Policy. For more information, read Cloud Armor Security Policy
# Concepts. (== resource_for `$api_version`.securityPolicies ==)
class SecurityPolicy
include Google::Apis::Core::Hashable
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Specifies a fingerprint for this resource, 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 get() request to the security policy.
# Corresponds to the JSON property `fingerprint`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :fingerprint
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output only] Type of the resource. Always compute#securityPolicyfor security
# policies
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# 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 security policy, a default rule with action "allow" will be
# added.
# Corresponds to the JSON property `rules`
# @return [Array<Google::Apis::ComputeV1::SecurityPolicyRule>]
attr_accessor :rules
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@fingerprint = args[:fingerprint] if args.key?(:fingerprint)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@rules = args[:rules] if args.key?(:rules)
@self_link = args[:self_link] if args.key?(:self_link)
end
end
#
class SecurityPolicyList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of SecurityPolicy resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::SecurityPolicy>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#securityPolicyList for listsof
# securityPolicies
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::SecurityPolicyList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::SecurityPolicyList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class SecurityPolicyReference
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `securityPolicy`
# @return [String]
attr_accessor :security_policy
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@security_policy = args[:security_policy] if args.key?(:security_policy)
end
end
# Represents a rule that describes one or more match conditions along with the
# action to be taken when traffic matches this condition (allow or deny).
class SecurityPolicyRule
include Google::Apis::Core::Hashable
# The Action to preform when the client connection triggers the rule. Can
# currently be either "allow" or "deny()" where valid values for status are 403,
# 404, and 502.
# Corresponds to the JSON property `action`
# @return [String]
attr_accessor :action
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output only] Type of the resource. Always compute#securityPolicyRule for
# security policy rules
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Represents a match condition that incoming traffic is evaluated against.
# Exactly one field must be specified.
# Corresponds to the JSON property `match`
# @return [Google::Apis::ComputeV1::SecurityPolicyRuleMatcher]
attr_accessor :match
# If set to true, the specified action is not enforced.
# Corresponds to the JSON property `preview`
# @return [Boolean]
attr_accessor :preview
alias_method :preview?, :preview
# 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
# prority.
# Corresponds to the JSON property `priority`
# @return [Fixnum]
attr_accessor :priority
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@action = args[:action] if args.key?(:action)
@description = args[:description] if args.key?(:description)
@kind = args[:kind] if args.key?(:kind)
@match = args[:match] if args.key?(:match)
@preview = args[:preview] if args.key?(:preview)
@priority = args[:priority] if args.key?(:priority)
end
end
# Represents a match condition that incoming traffic is evaluated against.
# Exactly one field must be specified.
class SecurityPolicyRuleMatcher
include Google::Apis::Core::Hashable
# The configuration options available when specifying versioned_expr. This field
# must be specified if versioned_expr is specified and cannot be specified if
# versioned_expr is not specified.
# Corresponds to the JSON property `config`
# @return [Google::Apis::ComputeV1::SecurityPolicyRuleMatcherConfig]
attr_accessor :config
# Represents a textual expression in the Common Expression Language (CEL) syntax.
# CEL is a C-like expression language. The syntax and semantics of CEL are
# documented at https://github.com/google/cel-spec.
# Example (Comparison):
# title: "Summary size limit" description: "Determines if a summary is less than
# 100 chars" expression: "document.summary.size() < 100"
# Example (Equality):
# title: "Requestor is owner" description: "Determines if requestor is the
# document owner" expression: "document.owner == request.auth.claims.email"
# Example (Logic):
# title: "Public documents" description: "Determine whether the document should
# be publicly visible" expression: "document.type != 'private' && document.type !
# = 'internal'"
# Example (Data Manipulation):
# title: "Notification string" description: "Create a notification string with a
# timestamp." expression: "'New message received at ' + string(document.
# create_time)"
# The exact variables and functions that may be referenced within an expression
# are determined by the service that evaluates it. See the service documentation
# for additional information.
# Corresponds to the JSON property `expr`
# @return [Google::Apis::ComputeV1::Expr]
attr_accessor :expr
# Preconfigured versioned expression. If this field is specified, config must
# also be specified. Available preconfigured expressions along with their
# requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range
# field in config.
# Corresponds to the JSON property `versionedExpr`
# @return [String]
attr_accessor :versioned_expr
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@config = args[:config] if args.key?(:config)
@expr = args[:expr] if args.key?(:expr)
@versioned_expr = args[:versioned_expr] if args.key?(:versioned_expr)
end
end
#
class SecurityPolicyRuleMatcherConfig
include Google::Apis::Core::Hashable
# CIDR IP address range.
# Corresponds to the JSON property `srcIpRanges`
# @return [Array<String>]
attr_accessor :src_ip_ranges
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@src_ip_ranges = args[:src_ip_ranges] if args.key?(:src_ip_ranges)
end
end
# An instance's serial console output.
class SerialPortOutput
include Google::Apis::Core::Hashable
# [Output Only] The contents of the console output.
# Corresponds to the JSON property `contents`
# @return [String]
attr_accessor :contents
# [Output Only] Type of the resource. Always compute#serialPortOutput for serial
# port output.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] The position of the next byte of content from the serial console
# output. Use this value in the next request as the start parameter.
# Corresponds to the JSON property `next`
# @return [Fixnum]
attr_accessor :next
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# The starting byte position of the output that was returned. This should match
# the start parameter sent with the request. If the serial console output
# exceeds the size of the buffer, older output will be overwritten by newer
# content and the start values will be mismatched.
# Corresponds to the JSON property `start`
# @return [Fixnum]
attr_accessor :start
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@contents = args[:contents] if args.key?(:contents)
@kind = args[:kind] if args.key?(:kind)
@next = args[:next] if args.key?(:next)
@self_link = args[:self_link] if args.key?(:self_link)
@start = args[:start] if args.key?(:start)
end
end
#
class ServerBinding
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@type = args[:type] if args.key?(:type)
end
end
# A service account.
class ServiceAccount
include Google::Apis::Core::Hashable
# Email address of the service account.
# Corresponds to the JSON property `email`
# @return [String]
attr_accessor :email
# The list of scopes to be made available for this service account.
# Corresponds to the JSON property `scopes`
# @return [Array<String>]
attr_accessor :scopes
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@email = args[:email] if args.key?(:email)
@scopes = args[:scopes] if args.key?(:scopes)
end
end
# A set of Shielded Instance options.
class ShieldedInstanceConfig
include Google::Apis::Core::Hashable
# Defines whether the instance has integrity monitoring enabled. Enabled by
# default.
# Corresponds to the JSON property `enableIntegrityMonitoring`
# @return [Boolean]
attr_accessor :enable_integrity_monitoring
alias_method :enable_integrity_monitoring?, :enable_integrity_monitoring
# Defines whether the instance has Secure Boot enabled. Disabled by default.
# Corresponds to the JSON property `enableSecureBoot`
# @return [Boolean]
attr_accessor :enable_secure_boot
alias_method :enable_secure_boot?, :enable_secure_boot
# Defines whether the instance has the vTPM enabled. Enabled by default.
# Corresponds to the JSON property `enableVtpm`
# @return [Boolean]
attr_accessor :enable_vtpm
alias_method :enable_vtpm?, :enable_vtpm
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@enable_integrity_monitoring = args[:enable_integrity_monitoring] if args.key?(:enable_integrity_monitoring)
@enable_secure_boot = args[:enable_secure_boot] if args.key?(:enable_secure_boot)
@enable_vtpm = args[:enable_vtpm] if args.key?(:enable_vtpm)
end
end
# A shielded Instance identity entry.
class ShieldedInstanceIdentity
include Google::Apis::Core::Hashable
# A Shielded Instance Identity Entry.
# Corresponds to the JSON property `encryptionKey`
# @return [Google::Apis::ComputeV1::ShieldedInstanceIdentityEntry]
attr_accessor :encryption_key
# [Output Only] Type of the resource. Always compute#shieldedInstanceIdentity
# for shielded Instance identity entry.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# A Shielded Instance Identity Entry.
# Corresponds to the JSON property `signingKey`
# @return [Google::Apis::ComputeV1::ShieldedInstanceIdentityEntry]
attr_accessor :signing_key
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@encryption_key = args[:encryption_key] if args.key?(:encryption_key)
@kind = args[:kind] if args.key?(:kind)
@signing_key = args[:signing_key] if args.key?(:signing_key)
end
end
# A Shielded Instance Identity Entry.
class ShieldedInstanceIdentityEntry
include Google::Apis::Core::Hashable
# A PEM-encoded X.509 certificate. This field can be empty.
# Corresponds to the JSON property `ekCert`
# @return [String]
attr_accessor :ek_cert
# A PEM-encoded public key.
# Corresponds to the JSON property `ekPub`
# @return [String]
attr_accessor :ek_pub
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@ek_cert = args[:ek_cert] if args.key?(:ek_cert)
@ek_pub = args[:ek_pub] if args.key?(:ek_pub)
end
end
# The policy describes the baseline against which Instance boot integrity is
# measured.
class ShieldedInstanceIntegrityPolicy
include Google::Apis::Core::Hashable
# Updates the integrity policy baseline using the measurements from the VM
# instance's most recent boot.
# Corresponds to the JSON property `updateAutoLearnPolicy`
# @return [Boolean]
attr_accessor :update_auto_learn_policy
alias_method :update_auto_learn_policy?, :update_auto_learn_policy
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@update_auto_learn_policy = args[:update_auto_learn_policy] if args.key?(:update_auto_learn_policy)
end
end
# Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs
class SignedUrlKey
include Google::Apis::Core::Hashable
# Name of the key. 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.
# Corresponds to the JSON property `keyName`
# @return [String]
attr_accessor :key_name
# 128-bit key value used for signing the URL. The key value must be a valid RFC
# 4648 Section 5 base64url encoded string.
# Corresponds to the JSON property `keyValue`
# @return [String]
attr_accessor :key_value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key_name = args[:key_name] if args.key?(:key_name)
@key_value = args[:key_value] if args.key?(:key_value)
end
end
# Represents a Persistent Disk Snapshot resource.
# You can use snapshots to back up data on a regular interval. For more
# information, read Creating persistent disk snapshots. (== resource_for `$
# api_version`.snapshots ==)
class Snapshot
include Google::Apis::Core::Hashable
# [Output Only] Set to true if snapshots are automatically created by applying
# resource policy on the target disk.
# Corresponds to the JSON property `autoCreated`
# @return [Boolean]
attr_accessor :auto_created
alias_method :auto_created?, :auto_created
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] Size of the source disk, specified in GB.
# Corresponds to the JSON property `diskSizeGb`
# @return [Fixnum]
attr_accessor :disk_size_gb
# [Output Only] Number of bytes downloaded to restore a snapshot to a disk.
# Corresponds to the JSON property `downloadBytes`
# @return [Fixnum]
attr_accessor :download_bytes
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] Type of the resource. Always compute#snapshot for Snapshot
# resources.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# A fingerprint for the labels being applied to this snapshot, 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 snapshot.
# Corresponds to the JSON property `labelFingerprint`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :label_fingerprint
# Labels to apply to this snapshot. These can be later modified by the setLabels
# method. Label values may be empty.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
# [Output Only] Integer license codes indicating which licenses are attached to
# this snapshot.
# Corresponds to the JSON property `licenseCodes`
# @return [Array<Fixnum>]
attr_accessor :license_codes
# [Output Only] A list of public visible licenses that apply to this snapshot.
# This can be because the original image had licenses attached (such as a
# Windows image).
# Corresponds to the JSON property `licenses`
# @return [Array<String>]
attr_accessor :licenses
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# Represents a customer-supplied encryption key
# Corresponds to the JSON property `snapshotEncryptionKey`
# @return [Google::Apis::ComputeV1::CustomerEncryptionKey]
attr_accessor :snapshot_encryption_key
# [Output Only] The source disk used to create this snapshot.
# Corresponds to the JSON property `sourceDisk`
# @return [String]
attr_accessor :source_disk
# Represents a customer-supplied encryption key
# Corresponds to the JSON property `sourceDiskEncryptionKey`
# @return [Google::Apis::ComputeV1::CustomerEncryptionKey]
attr_accessor :source_disk_encryption_key
# [Output Only] The ID value of the disk used to create this snapshot. This
# value may be used to determine whether the snapshot was taken from the current
# or a previous instance of a given disk name.
# Corresponds to the JSON property `sourceDiskId`
# @return [String]
attr_accessor :source_disk_id
# [Output Only] The status of the snapshot. This can be CREATING, DELETING,
# FAILED, READY, or UPLOADING.
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
# [Output Only] A size of the storage used by the snapshot. As snapshots share
# storage, this number is expected to change with snapshot creation/deletion.
# Corresponds to the JSON property `storageBytes`
# @return [Fixnum]
attr_accessor :storage_bytes
# [Output Only] An indicator whether storageBytes is in a stable state or it is
# being adjusted as a result of shared storage reallocation. This status can
# either be UPDATING, meaning the size of the snapshot is being updated, or
# UP_TO_DATE, meaning the size of the snapshot is up-to-date.
# Corresponds to the JSON property `storageBytesStatus`
# @return [String]
attr_accessor :storage_bytes_status
# Cloud Storage bucket storage location of the snapshot (regional or multi-
# regional).
# Corresponds to the JSON property `storageLocations`
# @return [Array<String>]
attr_accessor :storage_locations
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@auto_created = args[:auto_created] if args.key?(:auto_created)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb)
@download_bytes = args[:download_bytes] if args.key?(:download_bytes)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint)
@labels = args[:labels] if args.key?(:labels)
@license_codes = args[:license_codes] if args.key?(:license_codes)
@licenses = args[:licenses] if args.key?(:licenses)
@name = args[:name] if args.key?(:name)
@self_link = args[:self_link] if args.key?(:self_link)
@snapshot_encryption_key = args[:snapshot_encryption_key] if args.key?(:snapshot_encryption_key)
@source_disk = args[:source_disk] if args.key?(:source_disk)
@source_disk_encryption_key = args[:source_disk_encryption_key] if args.key?(:source_disk_encryption_key)
@source_disk_id = args[:source_disk_id] if args.key?(:source_disk_id)
@status = args[:status] if args.key?(:status)
@storage_bytes = args[:storage_bytes] if args.key?(:storage_bytes)
@storage_bytes_status = args[:storage_bytes_status] if args.key?(:storage_bytes_status)
@storage_locations = args[:storage_locations] if args.key?(:storage_locations)
end
end
# Contains a list of Snapshot resources.
class SnapshotList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of Snapshot resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::Snapshot>]
attr_accessor :items
# Type of resource.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::SnapshotList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::SnapshotList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# A specification of the parameters to use when creating the instance template
# from a source instance.
class SourceInstanceParams
include Google::Apis::Core::Hashable
# Attached disks configuration. If not provided, defaults are applied: For boot
# disk and any other R/W disks, new custom images will be created from each disk.
# For read-only disks, they will be attached in read-only mode. Local SSD disks
# will be created as blank volumes.
# Corresponds to the JSON property `diskConfigs`
# @return [Array<Google::Apis::ComputeV1::DiskInstantiationConfig>]
attr_accessor :disk_configs
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@disk_configs = args[:disk_configs] if args.key?(:disk_configs)
end
end
# Represents an SSL Certificate resource.
# Google Compute Engine has two SSL Certificate resources:
# * [Global](/compute/docs/reference/rest/`$api_version`/sslCertificates) * [
# Regional](/compute/docs/reference/rest/`$api_version`/regionSslCertificates)
# The sslCertificates are used by:
# - external HTTPS load balancers
# - SSL proxy load balancers
# The regionSslCertificates are used by internal HTTPS load balancers.
# Optionally, certificate file contents that you upload can contain a set of up
# to five PEM-encoded certificates. The API call creates an object (
# sslCertificate) that holds this data. You can use SSL keys and certificates to
# secure connections to a load balancer. For more information, read Creating
# and using SSL certificates, SSL certificates quotas and limits, and
# Troubleshooting SSL certificates. (== resource_for `$api_version`.
# sslCertificates ==) (== resource_for `$api_version`.regionSslCertificates ==)
class SslCertificate
include Google::Apis::Core::Hashable
# A local certificate file. The certificate must be in PEM format. The
# certificate chain must be no greater than 5 certs long. The chain must include
# at least one intermediate cert.
# Corresponds to the JSON property `certificate`
# @return [String]
attr_accessor :certificate
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] Expire time of the certificate. RFC3339
# Corresponds to the JSON property `expireTime`
# @return [String]
attr_accessor :expire_time
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] Type of the resource. Always compute#sslCertificate for SSL
# certificates.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Configuration and status of a managed SSL certificate.
# Corresponds to the JSON property `managed`
# @return [Google::Apis::ComputeV1::SslCertificateManagedSslCertificate]
attr_accessor :managed
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# A write-only private key in PEM format. Only insert requests will include this
# field.
# Corresponds to the JSON property `privateKey`
# @return [String]
attr_accessor :private_key
# [Output Only] URL of the region where the regional SSL Certificate resides.
# This field is not applicable to global SSL Certificate.
# Corresponds to the JSON property `region`
# @return [String]
attr_accessor :region
# [Output only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# Configuration and status of a self-managed SSL certificate.
# Corresponds to the JSON property `selfManaged`
# @return [Google::Apis::ComputeV1::SslCertificateSelfManagedSslCertificate]
attr_accessor :self_managed
# [Output Only] Domains associated with the certificate via Subject Alternative
# Name.
# Corresponds to the JSON property `subjectAlternativeNames`
# @return [Array<String>]
attr_accessor :subject_alternative_names
# (Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or "
# MANAGED". If not specified, the certificate is self-managed and the fields
# certificate and private_key are used.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@certificate = args[:certificate] if args.key?(:certificate)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@expire_time = args[:expire_time] if args.key?(:expire_time)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@managed = args[:managed] if args.key?(:managed)
@name = args[:name] if args.key?(:name)
@private_key = args[:private_key] if args.key?(:private_key)
@region = args[:region] if args.key?(:region)
@self_link = args[:self_link] if args.key?(:self_link)
@self_managed = args[:self_managed] if args.key?(:self_managed)
@subject_alternative_names = args[:subject_alternative_names] if args.key?(:subject_alternative_names)
@type = args[:type] if args.key?(:type)
end
end
#
class SslCertificateAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of SslCertificatesScopedList resources.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::SslCertificatesScopedList>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#sslCertificateAggregatedList
# for lists of SSL Certificates.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::SslCertificateAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::SslCertificateAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Contains a list of SslCertificate resources.
class SslCertificateList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of SslCertificate resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::SslCertificate>]
attr_accessor :items
# Type of resource.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::SslCertificateList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::SslCertificateList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Configuration and status of a managed SSL certificate.
class SslCertificateManagedSslCertificate
include Google::Apis::Core::Hashable
# [Output only] Detailed statuses of the domains specified for managed
# certificate resource.
# Corresponds to the JSON property `domainStatus`
# @return [Hash<String,String>]
attr_accessor :domain_status
# The domains for which a managed SSL certificate will be generated. Currently
# only single-domain certs are supported.
# Corresponds to the JSON property `domains`
# @return [Array<String>]
attr_accessor :domains
# [Output only] Status of the managed certificate resource.
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@domain_status = args[:domain_status] if args.key?(:domain_status)
@domains = args[:domains] if args.key?(:domains)
@status = args[:status] if args.key?(:status)
end
end
# Configuration and status of a self-managed SSL certificate.
class SslCertificateSelfManagedSslCertificate
include Google::Apis::Core::Hashable
# A local certificate file. The certificate must be in PEM format. The
# certificate chain must be no greater than 5 certs long. The chain must include
# at least one intermediate cert.
# Corresponds to the JSON property `certificate`
# @return [String]
attr_accessor :certificate
# A write-only private key in PEM format. Only insert requests will include this
# field.
# Corresponds to the JSON property `privateKey`
# @return [String]
attr_accessor :private_key
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@certificate = args[:certificate] if args.key?(:certificate)
@private_key = args[:private_key] if args.key?(:private_key)
end
end
#
class SslCertificatesScopedList
include Google::Apis::Core::Hashable
# List of SslCertificates contained in this scope.
# Corresponds to the JSON property `sslCertificates`
# @return [Array<Google::Apis::ComputeV1::SslCertificate>]
attr_accessor :ssl_certificates
# Informational warning which replaces the list of backend services when the
# list is empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::SslCertificatesScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@ssl_certificates = args[:ssl_certificates] if args.key?(:ssl_certificates)
@warning = args[:warning] if args.key?(:warning)
end
# Informational warning which replaces the list of backend services when the
# list is empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::SslCertificatesScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class SslPoliciesList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of SslPolicy resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::SslPolicy>]
attr_accessor :items
# [Output Only] Type of the resource. Always compute#sslPoliciesList for lists
# of sslPolicies.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::SslPoliciesList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::SslPoliciesList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class SslPoliciesListAvailableFeaturesResponse
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `features`
# @return [Array<String>]
attr_accessor :features
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@features = args[:features] if args.key?(:features)
end
end
# Represents a Cloud Armor Security Policy resource.
# Only external backend services used by HTTP or HTTPS load balancers can
# reference a Security Policy. For more information, read read Cloud Armor
# Security Policy Concepts. (== resource_for `$api_version`.sslPolicies ==)
class SslPolicy
include Google::Apis::Core::Hashable
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# A list of features enabled when the selected profile is CUSTOM. The
# - method returns the set of features that can be specified in this list. This
# field must be empty if the profile is not CUSTOM.
# Corresponds to the JSON property `customFeatures`
# @return [Array<String>]
attr_accessor :custom_features
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] The list of features enabled in the SSL policy.
# Corresponds to the JSON property `enabledFeatures`
# @return [Array<String>]
attr_accessor :enabled_features
# 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 SslPolicy. An up-to-date fingerprint must be provided in order to
# update the SslPolicy, otherwise the request will fail with error 412
# conditionNotMet.
# To see the latest fingerprint, make a get() request to retrieve an SslPolicy.
# Corresponds to the JSON property `fingerprint`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :fingerprint
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# The minimum version of SSL protocol that can be used by the clients to
# establish a connection with the load balancer. This can be one of TLS_1_0,
# TLS_1_1, TLS_1_2.
# Corresponds to the JSON property `minTlsVersion`
# @return [String]
attr_accessor :min_tls_version
# Name of the resource. 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Profile specifies the set of SSL features that can be used by the load
# balancer when negotiating SSL with clients. This can be one of COMPATIBLE,
# MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to
# enable must be specified in the customFeatures field.
# Corresponds to the JSON property `profile`
# @return [String]
attr_accessor :profile
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] If potential misconfigurations are detected for this SSL policy,
# this field will be populated with warning messages.
# Corresponds to the JSON property `warnings`
# @return [Array<Google::Apis::ComputeV1::SslPolicy::Warning>]
attr_accessor :warnings
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@custom_features = args[:custom_features] if args.key?(:custom_features)
@description = args[:description] if args.key?(:description)
@enabled_features = args[:enabled_features] if args.key?(:enabled_features)
@fingerprint = args[:fingerprint] if args.key?(:fingerprint)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@min_tls_version = args[:min_tls_version] if args.key?(:min_tls_version)
@name = args[:name] if args.key?(:name)
@profile = args[:profile] if args.key?(:profile)
@self_link = args[:self_link] if args.key?(:self_link)
@warnings = args[:warnings] if args.key?(:warnings)
end
#
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::SslPolicy::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class SslPolicyReference
include Google::Apis::Core::Hashable
# URL of the SSL policy resource. Set this to empty string to clear any existing
# SSL policy associated with the target proxy resource.
# Corresponds to the JSON property `sslPolicy`
# @return [String]
attr_accessor :ssl_policy
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@ssl_policy = args[:ssl_policy] if args.key?(:ssl_policy)
end
end
# Represents a Subnetwork resource.
# A subnetwork (also known as a subnet) is a logical partition of a Virtual
# Private Cloud network with one primary IP range and zero or more secondary IP
# ranges. For more information, read Virtual Private Cloud (VPC) Network. (==
# resource_for `$api_version`.subnetworks ==)
class Subnetwork
include Google::Apis::Core::Hashable
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this property when you
# create the resource. This field can be set only at resource creation time.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Whether to enable flow logging for this subnetwork. If this field is not
# explicitly set, it will not appear in get listings. If not set the default
# behavior is to disable flow logging. This field isn't supported with the
# purpose field set to INTERNAL_HTTPS_LOAD_BALANCER.
# Corresponds to the JSON property `enableFlowLogs`
# @return [Boolean]
attr_accessor :enable_flow_logs
alias_method :enable_flow_logs?, :enable_flow_logs
# 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 Subnetwork. An up-to-date fingerprint must be provided in order to
# update the Subnetwork, otherwise the request will fail with error 412
# conditionNotMet.
# To see the latest fingerprint, make a get() request to retrieve a Subnetwork.
# Corresponds to the JSON property `fingerprint`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :fingerprint
# [Output Only] The gateway address for default routes to reach destination
# addresses outside this subnetwork.
# Corresponds to the JSON property `gatewayAddress`
# @return [String]
attr_accessor :gateway_address
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# The range of internal addresses that are owned by this subnetwork. Provide
# this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.
# 168.0.0/16. Ranges must be unique and non-overlapping within a network. Only
# IPv4 is supported. This field is set at resource creation time. The range can
# be expanded after creation using expandIpCidrRange.
# Corresponds to the JSON property `ipCidrRange`
# @return [String]
attr_accessor :ip_cidr_range
# [Output Only] The range of internal IPv6 addresses that are owned by this
# subnetwork.
# Corresponds to the JSON property `ipv6CidrRange`
# @return [String]
attr_accessor :ipv6_cidr_range
# [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork
# resources.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# The available logging options for this subnetwork.
# Corresponds to the JSON property `logConfig`
# @return [Google::Apis::ComputeV1::SubnetworkLogConfig]
attr_accessor :log_config
# The name of the resource, provided by the client when initially creating the
# resource. 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The URL of the network to which this subnetwork belongs, provided by the
# client when initially creating the subnetwork. Only networks that are in the
# distributed mode can have subnetworks. This field can be set only at resource
# creation time.
# Corresponds to the JSON property `network`
# @return [String]
attr_accessor :network
# Whether the VMs in this subnet can access Google services without assigned
# external IP addresses. This field can be both set at resource creation time
# and updated using setPrivateIpGoogleAccess.
# Corresponds to the JSON property `privateIpGoogleAccess`
# @return [Boolean]
attr_accessor :private_ip_google_access
alias_method :private_ip_google_access?, :private_ip_google_access
# The private IPv6 google access type for the VMs in this subnet. This is an
# expanded field of enablePrivateV6Access. If both fields are set,
# privateIpv6GoogleAccess will take priority.
# This field can be both set at resource creation time and updated using patch.
# Corresponds to the JSON property `privateIpv6GoogleAccess`
# @return [String]
attr_accessor :private_ipv6_google_access
# The purpose of the resource. This field can be either PRIVATE_RFC_1918 or
# INTERNAL_HTTPS_LOAD_BALANCER. A subnetwork with purpose set to
# INTERNAL_HTTPS_LOAD_BALANCER is a user-created subnetwork that is reserved for
# Internal HTTP(S) Load Balancing. If unspecified, the purpose defaults to
# PRIVATE_RFC_1918. The enableFlowLogs field isn't supported with the purpose
# field set to INTERNAL_HTTPS_LOAD_BALANCER.
# Corresponds to the JSON property `purpose`
# @return [String]
attr_accessor :purpose
# URL of the region where the Subnetwork resides. This field can be set only at
# resource creation time.
# Corresponds to the JSON property `region`
# @return [String]
attr_accessor :region
# The role of subnetwork. Currently, this field is only used when purpose =
# INTERNAL_HTTPS_LOAD_BALANCER. The value can be set to ACTIVE or BACKUP. An
# ACTIVE subnetwork is one that is currently being used for Internal HTTP(S)
# Load Balancing. A BACKUP subnetwork is one that is ready to be promoted to
# ACTIVE or is currently draining. This field can be updated with a patch
# request.
# Corresponds to the JSON property `role`
# @return [String]
attr_accessor :role
# An array of configurations for secondary IP ranges for VM instances contained
# in this subnetwork. The primary IP of such VM must belong to the primary
# ipCidrRange of the subnetwork. The alias IPs may belong to either primary or
# secondary ranges. This field can be updated with a patch request.
# Corresponds to the JSON property `secondaryIpRanges`
# @return [Array<Google::Apis::ComputeV1::SubnetworkSecondaryRange>]
attr_accessor :secondary_ip_ranges
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] The state of the subnetwork, which can be one of READY or
# DRAINING. A subnetwork that is READY is ready to be used. The state of
# DRAINING is only applicable to subnetworks that have the purpose set to
# INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load
# balancer are being drained. A subnetwork that is draining cannot be used or
# modified until it reaches a status of READY.
# Corresponds to the JSON property `state`
# @return [String]
attr_accessor :state
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@enable_flow_logs = args[:enable_flow_logs] if args.key?(:enable_flow_logs)
@fingerprint = args[:fingerprint] if args.key?(:fingerprint)
@gateway_address = args[:gateway_address] if args.key?(:gateway_address)
@id = args[:id] if args.key?(:id)
@ip_cidr_range = args[:ip_cidr_range] if args.key?(:ip_cidr_range)
@ipv6_cidr_range = args[:ipv6_cidr_range] if args.key?(:ipv6_cidr_range)
@kind = args[:kind] if args.key?(:kind)
@log_config = args[:log_config] if args.key?(:log_config)
@name = args[:name] if args.key?(:name)
@network = args[:network] if args.key?(:network)
@private_ip_google_access = args[:private_ip_google_access] if args.key?(:private_ip_google_access)
@private_ipv6_google_access = args[:private_ipv6_google_access] if args.key?(:private_ipv6_google_access)
@purpose = args[:purpose] if args.key?(:purpose)
@region = args[:region] if args.key?(:region)
@role = args[:role] if args.key?(:role)
@secondary_ip_ranges = args[:secondary_ip_ranges] if args.key?(:secondary_ip_ranges)
@self_link = args[:self_link] if args.key?(:self_link)
@state = args[:state] if args.key?(:state)
end
end
#
class SubnetworkAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of SubnetworksScopedList resources.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::SubnetworksScopedList>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#subnetworkAggregatedList for
# aggregated lists of subnetworks.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::SubnetworkAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::SubnetworkAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Contains a list of Subnetwork resources.
class SubnetworkList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of Subnetwork resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::Subnetwork>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#subnetworkList for lists of
# subnetworks.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::SubnetworkList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::SubnetworkList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# The available logging options for this subnetwork.
class SubnetworkLogConfig
include Google::Apis::Core::Hashable
# Can only be specified if VPC flow logging for this subnetwork is enabled.
# Toggles the aggregation interval for collecting flow logs. Increasing the
# interval time will reduce the amount of generated flow logs for long lasting
# connections. Default is an interval of 5 seconds per connection.
# Corresponds to the JSON property `aggregationInterval`
# @return [String]
attr_accessor :aggregation_interval
# Whether to enable flow logging for this subnetwork. If this field is not
# explicitly set, it will not appear in get listings. If not set the default
# behavior is to disable flow logging.
# Corresponds to the JSON property `enable`
# @return [Boolean]
attr_accessor :enable
alias_method :enable?, :enable
# Can only be specified if VPC flow logs for this subnetwork is enabled. Export
# filter used to define which VPC flow logs should be logged.
# Corresponds to the JSON property `filterExpr`
# @return [String]
attr_accessor :filter_expr
# Can only be specified if VPC flow logging for this subnetwork is enabled. The
# value of the field must be in [0, 1]. Set the sampling rate of VPC flow logs
# within the subnetwork where 1.0 means all collected logs are reported and 0.0
# means no logs are reported. Default is 0.5, which means half of all collected
# logs are reported.
# Corresponds to the JSON property `flowSampling`
# @return [Float]
attr_accessor :flow_sampling
# Can only be specified if VPC flow logs for this subnetwork is enabled.
# Configures whether all, none or a subset of metadata fields should be added to
# the reported VPC flow logs. Default is INCLUDE_ALL_METADATA.
# Corresponds to the JSON property `metadata`
# @return [String]
attr_accessor :metadata
# Can only be specified if VPC flow logs for this subnetwork is enabled and "
# metadata" was set to CUSTOM_METADATA.
# Corresponds to the JSON property `metadataFields`
# @return [Array<String>]
attr_accessor :metadata_fields
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@aggregation_interval = args[:aggregation_interval] if args.key?(:aggregation_interval)
@enable = args[:enable] if args.key?(:enable)
@filter_expr = args[:filter_expr] if args.key?(:filter_expr)
@flow_sampling = args[:flow_sampling] if args.key?(:flow_sampling)
@metadata = args[:metadata] if args.key?(:metadata)
@metadata_fields = args[:metadata_fields] if args.key?(:metadata_fields)
end
end
# Represents a secondary IP range of a subnetwork.
class SubnetworkSecondaryRange
include Google::Apis::Core::Hashable
# The range of IP addresses belonging to this subnetwork secondary range.
# Provide this property when you create the subnetwork. Ranges must be unique
# and non-overlapping with all primary and secondary IP ranges within a network.
# Only IPv4 is supported.
# Corresponds to the JSON property `ipCidrRange`
# @return [String]
attr_accessor :ip_cidr_range
# The name associated with this subnetwork secondary range, used when adding an
# alias IP range to a VM instance. The name must be 1-63 characters long, and
# comply with RFC1035. The name must be unique within the subnetwork.
# Corresponds to the JSON property `rangeName`
# @return [String]
attr_accessor :range_name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@ip_cidr_range = args[:ip_cidr_range] if args.key?(:ip_cidr_range)
@range_name = args[:range_name] if args.key?(:range_name)
end
end
#
class SubnetworksExpandIpCidrRangeRequest
include Google::Apis::Core::Hashable
# The IP (in CIDR format or netmask) of internal addresses that are legal on
# this Subnetwork. This range should be disjoint from other subnetworks within
# this network. This range can only be larger than (i.e. a superset of) the
# range previously defined before the update.
# Corresponds to the JSON property `ipCidrRange`
# @return [String]
attr_accessor :ip_cidr_range
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@ip_cidr_range = args[:ip_cidr_range] if args.key?(:ip_cidr_range)
end
end
#
class SubnetworksScopedList
include Google::Apis::Core::Hashable
# A list of subnetworks contained in this scope.
# Corresponds to the JSON property `subnetworks`
# @return [Array<Google::Apis::ComputeV1::Subnetwork>]
attr_accessor :subnetworks
# An informational warning that appears when the list of addresses is empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::SubnetworksScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@subnetworks = args[:subnetworks] if args.key?(:subnetworks)
@warning = args[:warning] if args.key?(:warning)
end
# An informational warning that appears when the list of addresses is empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::SubnetworksScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class SubnetworksSetPrivateIpGoogleAccessRequest
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `privateIpGoogleAccess`
# @return [Boolean]
attr_accessor :private_ip_google_access
alias_method :private_ip_google_access?, :private_ip_google_access
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@private_ip_google_access = args[:private_ip_google_access] if args.key?(:private_ip_google_access)
end
end
#
class TcpHealthCheck
include Google::Apis::Core::Hashable
# The TCP port number for the health check request. The default value is 80.
# Valid values are 1 through 65535.
# Corresponds to the JSON property `port`
# @return [Fixnum]
attr_accessor :port
# Port name as defined in InstanceGroup#NamedPort#name. If both port and
# port_name are defined, port takes precedence.
# Corresponds to the JSON property `portName`
# @return [String]
attr_accessor :port_name
# Specifies how port is selected for health checking, can be one of following
# values:
# USE_FIXED_PORT: The port number in port is used for health checking.
# USE_NAMED_PORT: The portName is used for health checking.
# USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each
# network endpoint is used for health checking. For other backends, the port or
# named port specified in the Backend Service is used for health checking.
# If not specified, TCP health check follows behavior specified in port and
# portName fields.
# Corresponds to the JSON property `portSpecification`
# @return [String]
attr_accessor :port_specification
# Specifies the type of proxy header to append before sending data to the
# backend, either NONE or PROXY_V1. The default is NONE.
# Corresponds to the JSON property `proxyHeader`
# @return [String]
attr_accessor :proxy_header
# The application data to send once the TCP connection has been established (
# default value is empty). If both request and response are empty, the
# connection establishment alone will indicate health. The request data can only
# be ASCII.
# Corresponds to the JSON property `request`
# @return [String]
attr_accessor :request
# The bytes to match against the beginning of the response data. If left empty (
# the default value), any response will indicate health. The response data can
# only be ASCII.
# Corresponds to the JSON property `response`
# @return [String]
attr_accessor :response
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@port = args[:port] if args.key?(:port)
@port_name = args[:port_name] if args.key?(:port_name)
@port_specification = args[:port_specification] if args.key?(:port_specification)
@proxy_header = args[:proxy_header] if args.key?(:proxy_header)
@request = args[:request] if args.key?(:request)
@response = args[:response] if args.key?(:response)
end
end
# A set of instance tags.
class Tags
include Google::Apis::Core::Hashable
# Specifies a fingerprint for this request, which is essentially a hash of the
# tags' contents and used for optimistic locking. The fingerprint is initially
# generated by Compute Engine and changes after every request to modify or
# update tags. You must always provide an up-to-date fingerprint hash in order
# to update or change tags.
# To see the latest fingerprint, make get() request to the instance.
# Corresponds to the JSON property `fingerprint`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :fingerprint
# An array of tags. Each tag must be 1-63 characters long, and comply with
# RFC1035.
# Corresponds to the JSON property `items`
# @return [Array<String>]
attr_accessor :items
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@fingerprint = args[:fingerprint] if args.key?(:fingerprint)
@items = args[:items] if args.key?(:items)
end
end
# Represents a Target gRPC Proxy resource.
# A target gRPC proxy is a component of load balancers intended for load
# balancing gRPC traffic. Global forwarding rules reference a target gRPC proxy.
# The Target gRPC Proxy references a URL map which specifies how traffic routes
# to gRPC backend services.
class TargetGrpcProxy
include Google::Apis::Core::Hashable
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :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 TargetGrpcProxy. An up-to-date fingerprint must be provided in
# order to patch/update the TargetGrpcProxy; otherwise, the request will fail
# with error 412 conditionNotMet. To see the latest fingerprint, make a get()
# request to retrieve the TargetGrpcProxy.
# Corresponds to the JSON property `fingerprint`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :fingerprint
# [Output Only] The unique identifier for the resource type. The server
# generates this identifier.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] Type of the resource. Always compute#targetGrpcProxy for target
# grpc proxies.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Server-defined URL with id for the resource.
# Corresponds to the JSON property `selfLinkWithId`
# @return [String]
attr_accessor :self_link_with_id
# URL to the UrlMap resource that defines the mapping from URL to the
# BackendService. The protocol field in the BackendService must be set to GRPC.
# Corresponds to the JSON property `urlMap`
# @return [String]
attr_accessor :url_map
# If true, indicates that the BackendServices referenced by the urlMap may be
# accessed by gRPC applications without using a sidecar proxy. This will enable
# configuration checks on urlMap and its referenced BackendServices to not allow
# unsupported features. A gRPC application must use "xds-experimental:///"
# scheme in the target URI of the service it is connecting to. If false,
# indicates that the BackendServices referenced by the urlMap will be accessed
# by gRPC applications via a sidecar proxy. In this case, a gRPC application
# must not use "xds-experimental:///" scheme in the target URI of the service it
# is connecting to
# Corresponds to the JSON property `validateForProxyless`
# @return [Boolean]
attr_accessor :validate_for_proxyless
alias_method :validate_for_proxyless?, :validate_for_proxyless
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@fingerprint = args[:fingerprint] if args.key?(:fingerprint)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@self_link = args[:self_link] if args.key?(:self_link)
@self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id)
@url_map = args[:url_map] if args.key?(:url_map)
@validate_for_proxyless = args[:validate_for_proxyless] if args.key?(:validate_for_proxyless)
end
end
#
class TargetGrpcProxyList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of TargetGrpcProxy resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::TargetGrpcProxy>]
attr_accessor :items
# [Output Only] Type of the resource. Always compute#targetGrpcProxy for target
# grpc proxies.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::TargetGrpcProxyList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::TargetGrpcProxyList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class TargetHttpProxiesScopedList
include Google::Apis::Core::Hashable
# A list of TargetHttpProxies contained in this scope.
# Corresponds to the JSON property `targetHttpProxies`
# @return [Array<Google::Apis::ComputeV1::TargetHttpProxy>]
attr_accessor :target_http_proxies
# Informational warning which replaces the list of backend services when the
# list is empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::TargetHttpProxiesScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@target_http_proxies = args[:target_http_proxies] if args.key?(:target_http_proxies)
@warning = args[:warning] if args.key?(:warning)
end
# Informational warning which replaces the list of backend services when the
# list is empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::TargetHttpProxiesScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Represents a Target HTTP Proxy resource.
# Google Compute Engine has two Target HTTP Proxy resources:
# * [Global](/compute/docs/reference/rest/`$api_version`/targetHttpProxies) * [
# Regional](/compute/docs/reference/rest/`$api_version`/regionTargetHttpProxies)
# A target HTTP proxy is a component of GCP HTTP load balancers.
# * targetHttpProxies are used by external HTTP load balancers and Traffic
# Director. * regionTargetHttpProxies are used by internal HTTP load balancers.
# Forwarding rules reference a target HTTP proxy, and the target proxy then
# references a URL map. For more information, read Using Target Proxies and
# Forwarding rule concepts. (== resource_for `$api_version`.targetHttpProxies ==)
# (== resource_for `$api_version`.regionTargetHttpProxies ==)
class TargetHttpProxy
include Google::Apis::Core::Hashable
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP
# proxies.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# [Output Only] URL of the region where the regional Target HTTP Proxy resides.
# This field is not applicable to global Target HTTP Proxies.
# Corresponds to the JSON property `region`
# @return [String]
attr_accessor :region
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# URL to the UrlMap resource that defines the mapping from URL to the
# BackendService.
# Corresponds to the JSON property `urlMap`
# @return [String]
attr_accessor :url_map
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@region = args[:region] if args.key?(:region)
@self_link = args[:self_link] if args.key?(:self_link)
@url_map = args[:url_map] if args.key?(:url_map)
end
end
#
class TargetHttpProxyAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of TargetHttpProxiesScopedList resources.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::TargetHttpProxiesScopedList>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#targetHttpProxyAggregatedList
# for lists of Target HTTP Proxies.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
end
end
# A list of TargetHttpProxy resources.
class TargetHttpProxyList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of TargetHttpProxy resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::TargetHttpProxy>]
attr_accessor :items
# Type of resource. Always compute#targetHttpProxyList for lists of target HTTP
# proxies.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::TargetHttpProxyList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::TargetHttpProxyList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class TargetHttpsProxiesScopedList
include Google::Apis::Core::Hashable
# A list of TargetHttpsProxies contained in this scope.
# Corresponds to the JSON property `targetHttpsProxies`
# @return [Array<Google::Apis::ComputeV1::TargetHttpsProxy>]
attr_accessor :target_https_proxies
# Informational warning which replaces the list of backend services when the
# list is empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::TargetHttpsProxiesScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@target_https_proxies = args[:target_https_proxies] if args.key?(:target_https_proxies)
@warning = args[:warning] if args.key?(:warning)
end
# Informational warning which replaces the list of backend services when the
# list is empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::TargetHttpsProxiesScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class TargetHttpsProxiesSetQuicOverrideRequest
include Google::Apis::Core::Hashable
# QUIC policy for the TargetHttpsProxy resource.
# Corresponds to the JSON property `quicOverride`
# @return [String]
attr_accessor :quic_override
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@quic_override = args[:quic_override] if args.key?(:quic_override)
end
end
#
class TargetHttpsProxiesSetSslCertificatesRequest
include Google::Apis::Core::Hashable
# New set of SslCertificate resources to associate with this TargetHttpsProxy
# resource. Currently exactly one SslCertificate resource must be specified.
# Corresponds to the JSON property `sslCertificates`
# @return [Array<String>]
attr_accessor :ssl_certificates
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@ssl_certificates = args[:ssl_certificates] if args.key?(:ssl_certificates)
end
end
# Represents a Target HTTPS Proxy resource.
# Google Compute Engine has two Target HTTPS Proxy resources:
# * [Global](/compute/docs/reference/rest/`$api_version`/targetHttpsProxies) * [
# Regional](/compute/docs/reference/rest/`$api_version`/regionTargetHttpsProxies)
# A target HTTPS proxy is a component of GCP HTTPS load balancers.
# * targetHttpsProxies are used by external HTTPS load balancers. *
# regionTargetHttpsProxies are used by internal HTTPS load balancers.
# Forwarding rules reference a target HTTPS proxy, and the target proxy then
# references a URL map. For more information, read Using Target Proxies and
# Forwarding rule concepts. (== resource_for `$api_version`.targetHttpsProxies ==
# ) (== resource_for `$api_version`.regionTargetHttpsProxies ==)
class TargetHttpsProxy
include Google::Apis::Core::Hashable
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] Type of resource. Always compute#targetHttpsProxy for target
# HTTPS proxies.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Specifies the QUIC override policy for this TargetHttpsProxy resource. This
# setting determines whether the load balancer attempts to negotiate QUIC with
# clients. You can specify NONE, ENABLE, or DISABLE.
# - When quic-override is set to NONE, Google manages whether QUIC is used.
# - When quic-override is set to ENABLE, the load balancer uses QUIC when
# possible.
# - When quic-override is set to DISABLE, the load balancer doesn't use QUIC.
# - If the quic-override flag is not specified, NONE is implied.
# -
# Corresponds to the JSON property `quicOverride`
# @return [String]
attr_accessor :quic_override
# [Output Only] URL of the region where the regional TargetHttpsProxy resides.
# This field is not applicable to global TargetHttpsProxies.
# Corresponds to the JSON property `region`
# @return [String]
attr_accessor :region
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# URLs to SslCertificate resources that are used to authenticate connections
# between users and the load balancer. At least one SSL certificate must be
# specified. Currently, you may specify up to 15 SSL certificates.
# Corresponds to the JSON property `sslCertificates`
# @return [Array<String>]
attr_accessor :ssl_certificates
# URL of SslPolicy resource that will be associated with the TargetHttpsProxy
# resource. If not set, the TargetHttpsProxy resource has no SSL policy
# configured.
# Corresponds to the JSON property `sslPolicy`
# @return [String]
attr_accessor :ssl_policy
# A fully-qualified or valid partial URL to the UrlMap resource that defines the
# mapping from URL to the BackendService. For example, the following are all
# valid URLs for specifying a URL map:
# - https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map
# - projects/project/global/urlMaps/url-map
# - global/urlMaps/url-map
# Corresponds to the JSON property `urlMap`
# @return [String]
attr_accessor :url_map
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@quic_override = args[:quic_override] if args.key?(:quic_override)
@region = args[:region] if args.key?(:region)
@self_link = args[:self_link] if args.key?(:self_link)
@ssl_certificates = args[:ssl_certificates] if args.key?(:ssl_certificates)
@ssl_policy = args[:ssl_policy] if args.key?(:ssl_policy)
@url_map = args[:url_map] if args.key?(:url_map)
end
end
#
class TargetHttpsProxyAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of TargetHttpsProxiesScopedList resources.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::TargetHttpsProxiesScopedList>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#targetHttpsProxyAggregatedList
# for lists of Target HTTP Proxies.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::TargetHttpsProxyAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::TargetHttpsProxyAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Contains a list of TargetHttpsProxy resources.
class TargetHttpsProxyList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of TargetHttpsProxy resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::TargetHttpsProxy>]
attr_accessor :items
# Type of resource. Always compute#targetHttpsProxyList for lists of target
# HTTPS proxies.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::TargetHttpsProxyList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::TargetHttpsProxyList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Represents a Target Instance resource.
# You can use a target instance to handle traffic for one or more forwarding
# rules, which is ideal for forwarding protocol traffic that is managed by a
# single source. For example, ESP, AH, TCP, or UDP. For more information, read
# Target instances. (== resource_for `$api_version`.targetInstances ==)
class TargetInstance
include Google::Apis::Core::Hashable
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# A URL to the virtual machine instance that handles traffic for this target
# instance. When creating a target instance, you can provide the fully-qualified
# URL or a valid partial URL to the desired virtual machine. For example, the
# following are all valid URLs:
# - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/
# instance
# - projects/project/zones/zone/instances/instance
# - zones/zone/instances/instance
# Corresponds to the JSON property `instance`
# @return [String]
attr_accessor :instance
# [Output Only] The type of the resource. Always compute#targetInstance for
# target instances.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# NAT option controlling how IPs are NAT'ed to the instance. Currently only
# NO_NAT (default value) is supported.
# Corresponds to the JSON property `natPolicy`
# @return [String]
attr_accessor :nat_policy
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] URL of the zone where the target 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.
# Corresponds to the JSON property `zone`
# @return [String]
attr_accessor :zone
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@id = args[:id] if args.key?(:id)
@instance = args[:instance] if args.key?(:instance)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@nat_policy = args[:nat_policy] if args.key?(:nat_policy)
@self_link = args[:self_link] if args.key?(:self_link)
@zone = args[:zone] if args.key?(:zone)
end
end
#
class TargetInstanceAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of TargetInstance resources.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::TargetInstancesScopedList>]
attr_accessor :items
# Type of resource.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::TargetInstanceAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::TargetInstanceAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Contains a list of TargetInstance resources.
class TargetInstanceList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of TargetInstance resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::TargetInstance>]
attr_accessor :items
# Type of resource.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::TargetInstanceList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::TargetInstanceList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class TargetInstancesScopedList
include Google::Apis::Core::Hashable
# A list of target instances contained in this scope.
# Corresponds to the JSON property `targetInstances`
# @return [Array<Google::Apis::ComputeV1::TargetInstance>]
attr_accessor :target_instances
# Informational warning which replaces the list of addresses when the list is
# empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::TargetInstancesScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@target_instances = args[:target_instances] if args.key?(:target_instances)
@warning = args[:warning] if args.key?(:warning)
end
# Informational warning which replaces the list of addresses when the list is
# empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::TargetInstancesScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Represents a Target Pool resource.
# Target pools are used for network TCP/UDP load balancing. A target pool
# references member instances, an associated legacy HttpHealthCheck resource,
# and, optionally, a backup target pool. For more information, read Using target
# pools. (== resource_for `$api_version`.targetPools ==)
class TargetPool
include Google::Apis::Core::Hashable
# This field is applicable only when the containing target pool is serving a
# forwarding rule as the primary pool, and its failoverRatio field is properly
# set to a value between [0, 1].
# backupPool and failoverRatio together define the fallback behavior of the
# primary target pool: if the ratio of the healthy instances in the primary pool
# is at or below failoverRatio, traffic arriving at the load-balanced IP will be
# directed to the backup pool.
# In case where failoverRatio and backupPool are not set, or all the instances
# in the backup pool are unhealthy, the traffic will be directed back to the
# primary pool in the "force" mode, where traffic will be spread to the healthy
# instances with the best effort, or to all instances when no instance is
# healthy.
# Corresponds to the JSON property `backupPool`
# @return [String]
attr_accessor :backup_pool
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# This field is applicable only when the containing target pool is serving a
# forwarding rule as the primary pool (i.e., not as a backup pool to some other
# target pool). The value of the field must be in [0, 1].
# If set, backupPool must also be set. They together define the fallback
# behavior of the primary target pool: if the ratio of the healthy instances in
# the primary pool is at or below this number, traffic arriving at the load-
# balanced IP will be directed to the backup pool.
# In case where failoverRatio is not set or all the instances in the backup pool
# are unhealthy, the traffic will be directed back to the primary pool in the "
# force" mode, where traffic will be spread to the healthy instances with the
# best effort, or to all instances when no instance is healthy.
# Corresponds to the JSON property `failoverRatio`
# @return [Float]
attr_accessor :failover_ratio
# The URL of the HttpHealthCheck resource. A member instance in this pool is
# considered healthy if and only if the health checks pass. An empty list means
# all member instances will be considered healthy at all times. Only
# HttpHealthChecks are supported. Only one health check may be specified.
# Corresponds to the JSON property `healthChecks`
# @return [Array<String>]
attr_accessor :health_checks
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# A list of resource URLs to the virtual machine instances serving this pool.
# They must live in zones contained in the same region as this pool.
# Corresponds to the JSON property `instances`
# @return [Array<String>]
attr_accessor :instances
# [Output Only] Type of the resource. Always compute#targetPool for target pools.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# [Output Only] URL of the region where the target pool resides.
# Corresponds to the JSON property `region`
# @return [String]
attr_accessor :region
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# Session affinity option, must be one of the following values:
# NONE: Connections from the same client IP may go to any instance in the pool.
# CLIENT_IP: Connections from the same client IP will go to the same instance in
# the pool while that instance remains healthy.
# CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol
# will go to the same instance in the pool while that instance remains healthy.
# Corresponds to the JSON property `sessionAffinity`
# @return [String]
attr_accessor :session_affinity
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@backup_pool = args[:backup_pool] if args.key?(:backup_pool)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@failover_ratio = args[:failover_ratio] if args.key?(:failover_ratio)
@health_checks = args[:health_checks] if args.key?(:health_checks)
@id = args[:id] if args.key?(:id)
@instances = args[:instances] if args.key?(:instances)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@region = args[:region] if args.key?(:region)
@self_link = args[:self_link] if args.key?(:self_link)
@session_affinity = args[:session_affinity] if args.key?(:session_affinity)
end
end
#
class TargetPoolAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of TargetPool resources.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::TargetPoolsScopedList>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#targetPoolAggregatedList for
# aggregated lists of target pools.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::TargetPoolAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::TargetPoolAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class TargetPoolInstanceHealth
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `healthStatus`
# @return [Array<Google::Apis::ComputeV1::HealthStatus>]
attr_accessor :health_status
# [Output Only] Type of resource. Always compute#targetPoolInstanceHealth when
# checking the health of an instance.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@health_status = args[:health_status] if args.key?(:health_status)
@kind = args[:kind] if args.key?(:kind)
end
end
# Contains a list of TargetPool resources.
class TargetPoolList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of TargetPool resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::TargetPool>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#targetPoolList for lists of
# target pools.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::TargetPoolList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::TargetPoolList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class AddTargetPoolsHealthCheckRequest
include Google::Apis::Core::Hashable
# The HttpHealthCheck to add to the target pool.
# Corresponds to the JSON property `healthChecks`
# @return [Array<Google::Apis::ComputeV1::HealthCheckReference>]
attr_accessor :health_checks
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@health_checks = args[:health_checks] if args.key?(:health_checks)
end
end
#
class AddTargetPoolsInstanceRequest
include Google::Apis::Core::Hashable
# A full or partial URL to an instance to add to this target pool. This can be a
# full or partial URL. For example, the following are valid URLs:
# - https://www.googleapis.com/compute/v1/projects/project-id/zones/zone/
# instances/instance-name
# - projects/project-id/zones/zone/instances/instance-name
# - zones/zone/instances/instance-name
# Corresponds to the JSON property `instances`
# @return [Array<Google::Apis::ComputeV1::InstanceReference>]
attr_accessor :instances
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@instances = args[:instances] if args.key?(:instances)
end
end
#
class RemoveTargetPoolsHealthCheckRequest
include Google::Apis::Core::Hashable
# Health check URL to be removed. This can be a full or valid partial URL. For
# example, the following are valid URLs:
# - https://www.googleapis.com/compute/beta/projects/project/global/
# httpHealthChecks/health-check
# - projects/project/global/httpHealthChecks/health-check
# - global/httpHealthChecks/health-check
# Corresponds to the JSON property `healthChecks`
# @return [Array<Google::Apis::ComputeV1::HealthCheckReference>]
attr_accessor :health_checks
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@health_checks = args[:health_checks] if args.key?(:health_checks)
end
end
#
class RemoveTargetPoolsInstanceRequest
include Google::Apis::Core::Hashable
# URLs of the instances to be removed from target pool.
# Corresponds to the JSON property `instances`
# @return [Array<Google::Apis::ComputeV1::InstanceReference>]
attr_accessor :instances
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@instances = args[:instances] if args.key?(:instances)
end
end
#
class TargetPoolsScopedList
include Google::Apis::Core::Hashable
# A list of target pools contained in this scope.
# Corresponds to the JSON property `targetPools`
# @return [Array<Google::Apis::ComputeV1::TargetPool>]
attr_accessor :target_pools
# Informational warning which replaces the list of addresses when the list is
# empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::TargetPoolsScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@target_pools = args[:target_pools] if args.key?(:target_pools)
@warning = args[:warning] if args.key?(:warning)
end
# Informational warning which replaces the list of addresses when the list is
# empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::TargetPoolsScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class TargetReference
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `target`
# @return [String]
attr_accessor :target
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@target = args[:target] if args.key?(:target)
end
end
#
class TargetSslProxiesSetBackendServiceRequest
include Google::Apis::Core::Hashable
# The URL of the new BackendService resource for the targetSslProxy.
# Corresponds to the JSON property `service`
# @return [String]
attr_accessor :service
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@service = args[:service] if args.key?(:service)
end
end
#
class TargetSslProxiesSetProxyHeaderRequest
include Google::Apis::Core::Hashable
# The new type of proxy header to append before sending data to the backend.
# NONE or PROXY_V1 are allowed.
# Corresponds to the JSON property `proxyHeader`
# @return [String]
attr_accessor :proxy_header
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@proxy_header = args[:proxy_header] if args.key?(:proxy_header)
end
end
#
class TargetSslProxiesSetSslCertificatesRequest
include Google::Apis::Core::Hashable
# New set of URLs to SslCertificate resources to associate with this
# TargetSslProxy. Currently exactly one ssl certificate must be specified.
# Corresponds to the JSON property `sslCertificates`
# @return [Array<String>]
attr_accessor :ssl_certificates
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@ssl_certificates = args[:ssl_certificates] if args.key?(:ssl_certificates)
end
end
# Represents a Target SSL Proxy resource.
# A target SSL proxy is a component of a SSL Proxy load balancer. Global
# forwarding rules reference a target SSL proxy, and the target proxy then
# references an external backend service. For more information, read Using
# Target Proxies. (== resource_for `$api_version`.targetSslProxies ==)
class TargetSslProxy
include Google::Apis::Core::Hashable
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] Type of the resource. Always compute#targetSslProxy for target
# SSL proxies.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Specifies the type of proxy header to append before sending data to the
# backend, either NONE or PROXY_V1. The default is NONE.
# Corresponds to the JSON property `proxyHeader`
# @return [String]
attr_accessor :proxy_header
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# URL to the BackendService resource.
# Corresponds to the JSON property `service`
# @return [String]
attr_accessor :service
# URLs to SslCertificate resources that are used to authenticate connections to
# Backends. At least one SSL certificate must be specified. Currently, you may
# specify up to 15 SSL certificates.
# Corresponds to the JSON property `sslCertificates`
# @return [Array<String>]
attr_accessor :ssl_certificates
# URL of SslPolicy resource that will be associated with the TargetSslProxy
# resource. If not set, the TargetSslProxy resource will not have any SSL policy
# configured.
# Corresponds to the JSON property `sslPolicy`
# @return [String]
attr_accessor :ssl_policy
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@proxy_header = args[:proxy_header] if args.key?(:proxy_header)
@self_link = args[:self_link] if args.key?(:self_link)
@service = args[:service] if args.key?(:service)
@ssl_certificates = args[:ssl_certificates] if args.key?(:ssl_certificates)
@ssl_policy = args[:ssl_policy] if args.key?(:ssl_policy)
end
end
# Contains a list of TargetSslProxy resources.
class TargetSslProxyList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of TargetSslProxy resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::TargetSslProxy>]
attr_accessor :items
# Type of resource.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::TargetSslProxyList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::TargetSslProxyList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class TargetTcpProxiesSetBackendServiceRequest
include Google::Apis::Core::Hashable
# The URL of the new BackendService resource for the targetTcpProxy.
# Corresponds to the JSON property `service`
# @return [String]
attr_accessor :service
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@service = args[:service] if args.key?(:service)
end
end
#
class TargetTcpProxiesSetProxyHeaderRequest
include Google::Apis::Core::Hashable
# The new type of proxy header to append before sending data to the backend.
# NONE or PROXY_V1 are allowed.
# Corresponds to the JSON property `proxyHeader`
# @return [String]
attr_accessor :proxy_header
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@proxy_header = args[:proxy_header] if args.key?(:proxy_header)
end
end
# Represents a Target TCP Proxy resource.
# A target TCP proxy is a component of a TCP Proxy load balancer. Global
# forwarding rules reference target TCP proxy, and the target proxy then
# references an external backend service. For more information, read TCP Proxy
# Load Balancing overview. (== resource_for `$api_version`.targetTcpProxies ==)
class TargetTcpProxy
include Google::Apis::Core::Hashable
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] Type of the resource. Always compute#targetTcpProxy for target
# TCP proxies.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Specifies the type of proxy header to append before sending data to the
# backend, either NONE or PROXY_V1. The default is NONE.
# Corresponds to the JSON property `proxyHeader`
# @return [String]
attr_accessor :proxy_header
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# URL to the BackendService resource.
# Corresponds to the JSON property `service`
# @return [String]
attr_accessor :service
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@proxy_header = args[:proxy_header] if args.key?(:proxy_header)
@self_link = args[:self_link] if args.key?(:self_link)
@service = args[:service] if args.key?(:service)
end
end
# Contains a list of TargetTcpProxy resources.
class TargetTcpProxyList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of TargetTcpProxy resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::TargetTcpProxy>]
attr_accessor :items
# Type of resource.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::TargetTcpProxyList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::TargetTcpProxyList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Represents a Target VPN Gateway resource.
# The target VPN gateway resource represents a Classic Cloud VPN gateway. For
# more information, read the the Cloud VPN Overview. (== resource_for `$
# api_version`.targetVpnGateways ==)
class TargetVpnGateway
include Google::Apis::Core::Hashable
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules
# are created using compute.forwardingRules.insert and associated with a VPN
# gateway.
# Corresponds to the JSON property `forwardingRules`
# @return [Array<String>]
attr_accessor :forwarding_rules
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN
# gateways.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# URL of the network to which this VPN gateway is attached. Provided by the
# client when the VPN gateway is created.
# Corresponds to the JSON property `network`
# @return [String]
attr_accessor :network
# [Output Only] URL of the region where the target VPN gateway resides. You must
# specify this field as part of the HTTP request URL. It is not settable as a
# field in the request body.
# Corresponds to the JSON property `region`
# @return [String]
attr_accessor :region
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] The status of the VPN gateway, which can be one of the following:
# CREATING, READY, FAILED, or DELETING.
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
# [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created
# using the compute.vpntunnels.insert method and associated with a VPN gateway.
# Corresponds to the JSON property `tunnels`
# @return [Array<String>]
attr_accessor :tunnels
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@forwarding_rules = args[:forwarding_rules] if args.key?(:forwarding_rules)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@network = args[:network] if args.key?(:network)
@region = args[:region] if args.key?(:region)
@self_link = args[:self_link] if args.key?(:self_link)
@status = args[:status] if args.key?(:status)
@tunnels = args[:tunnels] if args.key?(:tunnels)
end
end
#
class TargetVpnGatewayAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of TargetVpnGateway resources.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::TargetVpnGatewaysScopedList>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN
# gateways.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::TargetVpnGatewayAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::TargetVpnGatewayAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Contains a list of TargetVpnGateway resources.
class TargetVpnGatewayList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of TargetVpnGateway resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::TargetVpnGateway>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN
# gateways.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::TargetVpnGatewayList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::TargetVpnGatewayList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class TargetVpnGatewaysScopedList
include Google::Apis::Core::Hashable
# [Output Only] A list of target VPN gateways contained in this scope.
# Corresponds to the JSON property `targetVpnGateways`
# @return [Array<Google::Apis::ComputeV1::TargetVpnGateway>]
attr_accessor :target_vpn_gateways
# [Output Only] Informational warning which replaces the list of addresses when
# the list is empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::TargetVpnGatewaysScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@target_vpn_gateways = args[:target_vpn_gateways] if args.key?(:target_vpn_gateways)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning which replaces the list of addresses when
# the list is empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::TargetVpnGatewaysScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class TestFailure
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `actualService`
# @return [String]
attr_accessor :actual_service
#
# Corresponds to the JSON property `expectedService`
# @return [String]
attr_accessor :expected_service
#
# Corresponds to the JSON property `host`
# @return [String]
attr_accessor :host
#
# Corresponds to the JSON property `path`
# @return [String]
attr_accessor :path
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@actual_service = args[:actual_service] if args.key?(:actual_service)
@expected_service = args[:expected_service] if args.key?(:expected_service)
@host = args[:host] if args.key?(:host)
@path = args[:path] if args.key?(:path)
end
end
#
class TestPermissionsRequest
include Google::Apis::Core::Hashable
# The set of permissions to check for the 'resource'. Permissions with wildcards
# (such as '*' or 'storage.*') are not allowed.
# Corresponds to the JSON property `permissions`
# @return [Array<String>]
attr_accessor :permissions
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@permissions = args[:permissions] if args.key?(:permissions)
end
end
#
class TestPermissionsResponse
include Google::Apis::Core::Hashable
# A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
# Corresponds to the JSON property `permissions`
# @return [Array<String>]
attr_accessor :permissions
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@permissions = args[:permissions] if args.key?(:permissions)
end
end
# Represents a URL Map resource.
# Google Compute Engine has two URL Map resources:
# * [Global](/compute/docs/reference/rest/`$api_version`/urlMaps) * [Regional](/
# compute/docs/reference/rest/`$api_version`/regionUrlMaps)
# A URL map resource is a component of certain types of GCP load balancers and
# Traffic Director.
# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. *
# regionUrlMaps are used by internal HTTP(S) load balancers.
# This resource defines mappings from host names and URL paths to either a
# backend service or a backend bucket.
# To use the global urlMaps resource, the backend service must have a
# loadBalancingScheme of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the
# regionUrlMaps resource, the backend service must have a loadBalancingScheme of
# INTERNAL_MANAGED. For more information, read URL Map Concepts.
class UrlMap
include Google::Apis::Core::Hashable
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# defaultRouteAction takes effect when none of the hostRules match. The load
# balancer performs advanced routing actions like URL rewrites, header
# transformations, etc. prior to forwarding the request to the selected backend.
# If defaultRouteAction specifies any weightedBackendServices, defaultService
# must not be set. Conversely if defaultService is set, defaultRouteAction
# cannot contain any weightedBackendServices.
# Only one of defaultRouteAction or defaultUrlRedirect must be set.
# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action
# within defaultRouteAction.
# Corresponds to the JSON property `defaultRouteAction`
# @return [Google::Apis::ComputeV1::HttpRouteAction]
attr_accessor :default_route_action
# The full or partial URL of the defaultService resource to which traffic is
# directed if none of the hostRules match. If defaultRouteAction is additionally
# specified, advanced routing actions like URL Rewrites, etc. take effect prior
# to sending the request to the backend. However, if defaultService is specified,
# defaultRouteAction cannot contain any weightedBackendServices. Conversely, if
# routeAction specifies any weightedBackendServices, service must not be
# specified.
# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.
# weightedBackendService must be set.
# Corresponds to the JSON property `defaultService`
# @return [String]
attr_accessor :default_service
# Specifies settings for an HTTP redirect.
# Corresponds to the JSON property `defaultUrlRedirect`
# @return [Google::Apis::ComputeV1::HttpRedirectAction]
attr_accessor :default_url_redirect
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :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 UrlMap. An up-to-date fingerprint must be provided in order to
# update the UrlMap, otherwise the request will fail with error 412
# conditionNotMet.
# To see the latest fingerprint, make a get() request to retrieve a UrlMap.
# Corresponds to the JSON property `fingerprint`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :fingerprint
# The request and response header transformations that take effect before the
# request is passed along to the selected backendService.
# Corresponds to the JSON property `headerAction`
# @return [Google::Apis::ComputeV1::HttpHeaderAction]
attr_accessor :header_action
# The list of HostRules to use against the URL.
# Corresponds to the JSON property `hostRules`
# @return [Array<Google::Apis::ComputeV1::HostRule>]
attr_accessor :host_rules
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] Type of the resource. Always compute#urlMaps for url maps.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The list of named PathMatchers to use against the URL.
# Corresponds to the JSON property `pathMatchers`
# @return [Array<Google::Apis::ComputeV1::PathMatcher>]
attr_accessor :path_matchers
# [Output Only] URL of the region where the regional URL map resides. This field
# is not applicable to global URL maps. You must specify this field as part of
# the HTTP request URL. It is not settable as a field in the request body.
# Corresponds to the JSON property `region`
# @return [String]
attr_accessor :region
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# The list of expected URL mapping tests. Request to update this UrlMap will
# succeed only if all of the test cases pass. You can specify a maximum of 100
# tests per UrlMap.
# Corresponds to the JSON property `tests`
# @return [Array<Google::Apis::ComputeV1::UrlMapTest>]
attr_accessor :tests
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@default_route_action = args[:default_route_action] if args.key?(:default_route_action)
@default_service = args[:default_service] if args.key?(:default_service)
@default_url_redirect = args[:default_url_redirect] if args.key?(:default_url_redirect)
@description = args[:description] if args.key?(:description)
@fingerprint = args[:fingerprint] if args.key?(:fingerprint)
@header_action = args[:header_action] if args.key?(:header_action)
@host_rules = args[:host_rules] if args.key?(:host_rules)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@path_matchers = args[:path_matchers] if args.key?(:path_matchers)
@region = args[:region] if args.key?(:region)
@self_link = args[:self_link] if args.key?(:self_link)
@tests = args[:tests] if args.key?(:tests)
end
end
# Contains a list of UrlMap resources.
class UrlMapList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of UrlMap resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::UrlMap>]
attr_accessor :items
# Type of resource.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::UrlMapList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::UrlMapList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class UrlMapReference
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `urlMap`
# @return [String]
attr_accessor :url_map
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@url_map = args[:url_map] if args.key?(:url_map)
end
end
# Message for the expected URL mappings.
class UrlMapTest
include Google::Apis::Core::Hashable
# Description of this test case.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Host portion of the URL.
# Corresponds to the JSON property `host`
# @return [String]
attr_accessor :host
# Path portion of the URL.
# Corresponds to the JSON property `path`
# @return [String]
attr_accessor :path
# Expected BackendService resource the given URL should be mapped to.
# Corresponds to the JSON property `service`
# @return [String]
attr_accessor :service
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@description = args[:description] if args.key?(:description)
@host = args[:host] if args.key?(:host)
@path = args[:path] if args.key?(:path)
@service = args[:service] if args.key?(:service)
end
end
# Message representing the validation result for a UrlMap.
class UrlMapValidationResult
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `loadErrors`
# @return [Array<String>]
attr_accessor :load_errors
# Whether the given UrlMap can be successfully loaded. If false, 'loadErrors'
# indicates the reasons.
# Corresponds to the JSON property `loadSucceeded`
# @return [Boolean]
attr_accessor :load_succeeded
alias_method :load_succeeded?, :load_succeeded
#
# Corresponds to the JSON property `testFailures`
# @return [Array<Google::Apis::ComputeV1::TestFailure>]
attr_accessor :test_failures
# If successfully loaded, this field indicates whether the test passed. If false,
# 'testFailures's indicate the reason of failure.
# Corresponds to the JSON property `testPassed`
# @return [Boolean]
attr_accessor :test_passed
alias_method :test_passed?, :test_passed
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@load_errors = args[:load_errors] if args.key?(:load_errors)
@load_succeeded = args[:load_succeeded] if args.key?(:load_succeeded)
@test_failures = args[:test_failures] if args.key?(:test_failures)
@test_passed = args[:test_passed] if args.key?(:test_passed)
end
end
#
class UrlMapsAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of UrlMapsScopedList resources.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::UrlMapsScopedList>]
attr_accessor :items
# Type of resource.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::UrlMapsAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::UrlMapsAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class UrlMapsScopedList
include Google::Apis::Core::Hashable
# A list of UrlMaps contained in this scope.
# Corresponds to the JSON property `urlMaps`
# @return [Array<Google::Apis::ComputeV1::UrlMap>]
attr_accessor :url_maps
# Informational warning which replaces the list of backend services when the
# list is empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::UrlMapsScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@url_maps = args[:url_maps] if args.key?(:url_maps)
@warning = args[:warning] if args.key?(:warning)
end
# Informational warning which replaces the list of backend services when the
# list is empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::UrlMapsScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class ValidateUrlMapsRequest
include Google::Apis::Core::Hashable
# Represents a URL Map resource.
# Google Compute Engine has two URL Map resources:
# * [Global](/compute/docs/reference/rest/`$api_version`/urlMaps) * [Regional](/
# compute/docs/reference/rest/`$api_version`/regionUrlMaps)
# A URL map resource is a component of certain types of GCP load balancers and
# Traffic Director.
# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. *
# regionUrlMaps are used by internal HTTP(S) load balancers.
# This resource defines mappings from host names and URL paths to either a
# backend service or a backend bucket.
# To use the global urlMaps resource, the backend service must have a
# loadBalancingScheme of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the
# regionUrlMaps resource, the backend service must have a loadBalancingScheme of
# INTERNAL_MANAGED. For more information, read URL Map Concepts.
# Corresponds to the JSON property `resource`
# @return [Google::Apis::ComputeV1::UrlMap]
attr_accessor :resource
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@resource = args[:resource] if args.key?(:resource)
end
end
#
class ValidateUrlMapsResponse
include Google::Apis::Core::Hashable
# Message representing the validation result for a UrlMap.
# Corresponds to the JSON property `result`
# @return [Google::Apis::ComputeV1::UrlMapValidationResult]
attr_accessor :result
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@result = args[:result] if args.key?(:result)
end
end
# The spec for modifying the path before sending the request to the matched
# backend service.
class UrlRewrite
include Google::Apis::Core::Hashable
# Prior to forwarding the request to the selected service, the request's host
# header is replaced with contents of hostRewrite.
# The value must be between 1 and 255 characters.
# Corresponds to the JSON property `hostRewrite`
# @return [String]
attr_accessor :host_rewrite
# Prior to forwarding the request to the selected backend service, the matching
# portion of the request's path is replaced by pathPrefixRewrite.
# The value must be between 1 and 1024 characters.
# Corresponds to the JSON property `pathPrefixRewrite`
# @return [String]
attr_accessor :path_prefix_rewrite
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@host_rewrite = args[:host_rewrite] if args.key?(:host_rewrite)
@path_prefix_rewrite = args[:path_prefix_rewrite] if args.key?(:path_prefix_rewrite)
end
end
# Subnetwork which the current user has compute.subnetworks.use permission on.
class UsableSubnetwork
include Google::Apis::Core::Hashable
# The range of internal addresses that are owned by this subnetwork.
# Corresponds to the JSON property `ipCidrRange`
# @return [String]
attr_accessor :ip_cidr_range
# Network URL.
# Corresponds to the JSON property `network`
# @return [String]
attr_accessor :network
# Secondary IP ranges.
# Corresponds to the JSON property `secondaryIpRanges`
# @return [Array<Google::Apis::ComputeV1::UsableSubnetworkSecondaryRange>]
attr_accessor :secondary_ip_ranges
# Subnetwork URL.
# Corresponds to the JSON property `subnetwork`
# @return [String]
attr_accessor :subnetwork
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@ip_cidr_range = args[:ip_cidr_range] if args.key?(:ip_cidr_range)
@network = args[:network] if args.key?(:network)
@secondary_ip_ranges = args[:secondary_ip_ranges] if args.key?(:secondary_ip_ranges)
@subnetwork = args[:subnetwork] if args.key?(:subnetwork)
end
end
# Secondary IP range of a usable subnetwork.
class UsableSubnetworkSecondaryRange
include Google::Apis::Core::Hashable
# The range of IP addresses belonging to this subnetwork secondary range.
# Corresponds to the JSON property `ipCidrRange`
# @return [String]
attr_accessor :ip_cidr_range
# The name associated with this subnetwork secondary range, used when adding an
# alias IP range to a VM instance. The name must be 1-63 characters long, and
# comply with RFC1035. The name must be unique within the subnetwork.
# Corresponds to the JSON property `rangeName`
# @return [String]
attr_accessor :range_name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@ip_cidr_range = args[:ip_cidr_range] if args.key?(:ip_cidr_range)
@range_name = args[:range_name] if args.key?(:range_name)
end
end
#
class UsableSubnetworksAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# [Output] A list of usable subnetwork URLs.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::UsableSubnetwork>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#usableSubnetworksAggregatedList
# for aggregated lists of usable subnetworks.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::UsableSubnetworksAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::UsableSubnetworksAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# The location in Cloud Storage and naming method of the daily usage report.
# Contains bucket_name and report_name prefix.
class UsageExportLocation
include Google::Apis::Core::Hashable
# The name of an existing bucket in Cloud Storage where the usage report object
# is stored. The Google Service Account is granted write access to this bucket.
# This can either be the bucket name by itself, such as example-bucket, or the
# bucket name with gs:// or https://storage.googleapis.com/ in front of it, such
# as gs://example-bucket.
# Corresponds to the JSON property `bucketName`
# @return [String]
attr_accessor :bucket_name
# An optional prefix for the name of the usage report object stored in
# bucketName. If not supplied, defaults to usage. The report is stored as a CSV
# file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of
# the usage according to Pacific Time. If you supply a prefix, it should conform
# to Cloud Storage object naming conventions.
# Corresponds to the JSON property `reportNamePrefix`
# @return [String]
attr_accessor :report_name_prefix
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@bucket_name = args[:bucket_name] if args.key?(:bucket_name)
@report_name_prefix = args[:report_name_prefix] if args.key?(:report_name_prefix)
end
end
# Contain information of Nat mapping for a VM endpoint (i.e., NIC).
class VmEndpointNatMappings
include Google::Apis::Core::Hashable
# Name of the VM instance which the endpoint belongs to
# Corresponds to the JSON property `instanceName`
# @return [String]
attr_accessor :instance_name
#
# Corresponds to the JSON property `interfaceNatMappings`
# @return [Array<Google::Apis::ComputeV1::VmEndpointNatMappingsInterfaceNatMappings>]
attr_accessor :interface_nat_mappings
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@instance_name = args[:instance_name] if args.key?(:instance_name)
@interface_nat_mappings = args[:interface_nat_mappings] if args.key?(:interface_nat_mappings)
end
end
# Contain information of Nat mapping for an interface of this endpoint.
class VmEndpointNatMappingsInterfaceNatMappings
include Google::Apis::Core::Hashable
# List of all drain IP:port-range mappings assigned to this interface. These
# ranges are inclusive, that is, both the first and the last ports can be used
# for NAT. Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"].
# Corresponds to the JSON property `drainNatIpPortRanges`
# @return [Array<String>]
attr_accessor :drain_nat_ip_port_ranges
# A list of all IP:port-range mappings assigned to this interface. These ranges
# are inclusive, that is, both the first and the last ports can be used for NAT.
# Example: ["2.2.2.2:12345-12355", "1.1.1.1:2234-2234"].
# Corresponds to the JSON property `natIpPortRanges`
# @return [Array<String>]
attr_accessor :nat_ip_port_ranges
# Total number of drain ports across all NAT IPs allocated to this interface. It
# equals to the aggregated port number in the field drain_nat_ip_port_ranges.
# Corresponds to the JSON property `numTotalDrainNatPorts`
# @return [Fixnum]
attr_accessor :num_total_drain_nat_ports
# Total number of ports across all NAT IPs allocated to this interface. It
# equals to the aggregated port number in the field nat_ip_port_ranges.
# Corresponds to the JSON property `numTotalNatPorts`
# @return [Fixnum]
attr_accessor :num_total_nat_ports
# Alias IP range for this interface endpoint. It will be a private (RFC 1918) IP
# range. Examples: "10.33.4.55/32", or "192.168.5.0/24".
# Corresponds to the JSON property `sourceAliasIpRange`
# @return [String]
attr_accessor :source_alias_ip_range
# Primary IP of the VM for this NIC.
# Corresponds to the JSON property `sourceVirtualIp`
# @return [String]
attr_accessor :source_virtual_ip
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@drain_nat_ip_port_ranges = args[:drain_nat_ip_port_ranges] if args.key?(:drain_nat_ip_port_ranges)
@nat_ip_port_ranges = args[:nat_ip_port_ranges] if args.key?(:nat_ip_port_ranges)
@num_total_drain_nat_ports = args[:num_total_drain_nat_ports] if args.key?(:num_total_drain_nat_ports)
@num_total_nat_ports = args[:num_total_nat_ports] if args.key?(:num_total_nat_ports)
@source_alias_ip_range = args[:source_alias_ip_range] if args.key?(:source_alias_ip_range)
@source_virtual_ip = args[:source_virtual_ip] if args.key?(:source_virtual_ip)
end
end
# Contains a list of VmEndpointNatMappings.
class VmEndpointNatMappingsList
include Google::Apis::Core::Hashable
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# [Output Only] Type of resource. Always compute#vmEndpointNatMappingsList for
# lists of Nat mappings of VM endpoints.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] A list of Nat mapping information of VM endpoints.
# Corresponds to the JSON property `result`
# @return [Array<Google::Apis::ComputeV1::VmEndpointNatMappings>]
attr_accessor :result
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::VmEndpointNatMappingsList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@result = args[:result] if args.key?(:result)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::VmEndpointNatMappingsList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Represents a HA VPN gateway.
# HA VPN is a high-availability (HA) Cloud VPN solution that lets you securely
# connect your on-premises network to your Google Cloud Virtual Private Cloud
# network through an IPsec VPN connection in a single region. For more
# information about Cloud HA VPN solutions, see Cloud VPN topologies . (==
# resource_for `$api_version`.vpnGateways ==)
class VpnGateway
include Google::Apis::Core::Hashable
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# A fingerprint for the labels being applied to this VpnGateway, 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 an VpnGateway.
# Corresponds to the JSON property `labelFingerprint`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :label_fingerprint
# 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.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# URL of the network to which this VPN gateway is attached. Provided by the
# client when the VPN gateway is created.
# Corresponds to the JSON property `network`
# @return [String]
attr_accessor :network
# [Output Only] URL of the region where the VPN gateway resides.
# Corresponds to the JSON property `region`
# @return [String]
attr_accessor :region
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# A list of interfaces on this VPN gateway.
# Corresponds to the JSON property `vpnInterfaces`
# @return [Array<Google::Apis::ComputeV1::VpnGatewayVpnGatewayInterface>]
attr_accessor :vpn_interfaces
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint)
@labels = args[:labels] if args.key?(:labels)
@name = args[:name] if args.key?(:name)
@network = args[:network] if args.key?(:network)
@region = args[:region] if args.key?(:region)
@self_link = args[:self_link] if args.key?(:self_link)
@vpn_interfaces = args[:vpn_interfaces] if args.key?(:vpn_interfaces)
end
end
#
class VpnGatewayAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of VpnGateway resources.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::VpnGatewaysScopedList>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::VpnGatewayAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::VpnGatewayAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Contains a list of VpnGateway resources.
class VpnGatewayList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of VpnGateway resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::VpnGateway>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::VpnGatewayList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::VpnGatewayList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class VpnGatewayStatus
include Google::Apis::Core::Hashable
# List of VPN connection for this VpnGateway.
# Corresponds to the JSON property `vpnConnections`
# @return [Array<Google::Apis::ComputeV1::VpnGatewayStatusVpnConnection>]
attr_accessor :vpn_connections
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@vpn_connections = args[:vpn_connections] if args.key?(:vpn_connections)
end
end
# Describes the high availability requirement state for the VPN connection
# between this Cloud VPN gateway and a peer gateway.
class VpnGatewayStatusHighAvailabilityRequirementState
include Google::Apis::Core::Hashable
# Indicates the high availability requirement state for the VPN connection.
# Valid values are CONNECTION_REDUNDANCY_MET, CONNECTION_REDUNDANCY_NOT_MET.
# Corresponds to the JSON property `state`
# @return [String]
attr_accessor :state
# Indicates the reason why the VPN connection does not meet the high
# availability redundancy criteria/requirement. Valid values is
# INCOMPLETE_TUNNELS_COVERAGE.
# Corresponds to the JSON property `unsatisfiedReason`
# @return [String]
attr_accessor :unsatisfied_reason
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@state = args[:state] if args.key?(:state)
@unsatisfied_reason = args[:unsatisfied_reason] if args.key?(:unsatisfied_reason)
end
end
# Contains some information about a VPN tunnel.
class VpnGatewayStatusTunnel
include Google::Apis::Core::Hashable
# The VPN gateway interface this VPN tunnel is associated with.
# Corresponds to the JSON property `localGatewayInterface`
# @return [Fixnum]
attr_accessor :local_gateway_interface
# The peer gateway interface this VPN tunnel is connected to, the peer gateway
# could either be an external VPN gateway or GCP VPN gateway.
# Corresponds to the JSON property `peerGatewayInterface`
# @return [Fixnum]
attr_accessor :peer_gateway_interface
# URL reference to the VPN tunnel.
# Corresponds to the JSON property `tunnelUrl`
# @return [String]
attr_accessor :tunnel_url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@local_gateway_interface = args[:local_gateway_interface] if args.key?(:local_gateway_interface)
@peer_gateway_interface = args[:peer_gateway_interface] if args.key?(:peer_gateway_interface)
@tunnel_url = args[:tunnel_url] if args.key?(:tunnel_url)
end
end
# A VPN connection contains all VPN tunnels connected from this VpnGateway to
# the same peer gateway. The peer gateway could either be a external VPN gateway
# or GCP VPN gateway.
class VpnGatewayStatusVpnConnection
include Google::Apis::Core::Hashable
# URL reference to the peer external VPN gateways to which the VPN tunnels in
# this VPN connection are connected. This field is mutually exclusive with
# peer_gcp_gateway.
# Corresponds to the JSON property `peerExternalGateway`
# @return [String]
attr_accessor :peer_external_gateway
# URL reference to the peer side VPN gateways to which the VPN tunnels in this
# VPN connection are connected. This field is mutually exclusive with
# peer_gcp_gateway.
# Corresponds to the JSON property `peerGcpGateway`
# @return [String]
attr_accessor :peer_gcp_gateway
# Describes the high availability requirement state for the VPN connection
# between this Cloud VPN gateway and a peer gateway.
# Corresponds to the JSON property `state`
# @return [Google::Apis::ComputeV1::VpnGatewayStatusHighAvailabilityRequirementState]
attr_accessor :state
# List of VPN tunnels that are in this VPN connection.
# Corresponds to the JSON property `tunnels`
# @return [Array<Google::Apis::ComputeV1::VpnGatewayStatusTunnel>]
attr_accessor :tunnels
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@peer_external_gateway = args[:peer_external_gateway] if args.key?(:peer_external_gateway)
@peer_gcp_gateway = args[:peer_gcp_gateway] if args.key?(:peer_gcp_gateway)
@state = args[:state] if args.key?(:state)
@tunnels = args[:tunnels] if args.key?(:tunnels)
end
end
# A VPN gateway interface.
class VpnGatewayVpnGatewayInterface
include Google::Apis::Core::Hashable
# The numeric ID of this VPN gateway interface.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] The external IP address for this VPN gateway interface.
# Corresponds to the JSON property `ipAddress`
# @return [String]
attr_accessor :ip_address
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@ip_address = args[:ip_address] if args.key?(:ip_address)
end
end
#
class VpnGatewaysGetStatusResponse
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `result`
# @return [Google::Apis::ComputeV1::VpnGatewayStatus]
attr_accessor :result
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@result = args[:result] if args.key?(:result)
end
end
#
class VpnGatewaysScopedList
include Google::Apis::Core::Hashable
# [Output Only] A list of VPN gateways contained in this scope.
# Corresponds to the JSON property `vpnGateways`
# @return [Array<Google::Apis::ComputeV1::VpnGateway>]
attr_accessor :vpn_gateways
# [Output Only] Informational warning which replaces the list of addresses when
# the list is empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::VpnGatewaysScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@vpn_gateways = args[:vpn_gateways] if args.key?(:vpn_gateways)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning which replaces the list of addresses when
# the list is empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::VpnGatewaysScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Represents a Cloud VPN Tunnel resource.
# For more information about VPN, read the the Cloud VPN Overview. (==
# resource_for `$api_version`.vpnTunnels ==)
class VpnTunnel
include Google::Apis::Core::Hashable
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# An optional description of this resource. Provide this property when you
# create the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] Detailed status message for the VPN tunnel.
# Corresponds to the JSON property `detailedStatus`
# @return [String]
attr_accessor :detailed_status
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# IKE protocol version to use when establishing the VPN tunnel with the peer VPN
# gateway. Acceptable IKE versions are 1 or 2. The default version is 2.
# Corresponds to the JSON property `ikeVersion`
# @return [Fixnum]
attr_accessor :ike_version
# [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Local traffic selector to use when establishing the VPN tunnel with the peer
# VPN gateway. The value should be a CIDR formatted string, for example: 192.168.
# 0.0/16. The ranges must be disjoint. Only IPv4 is supported.
# Corresponds to the JSON property `localTrafficSelector`
# @return [Array<String>]
attr_accessor :local_traffic_selector
# 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.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# URL of the peer side external VPN gateway to which this VPN tunnel is
# connected. Provided by the client when the VPN tunnel is created. This field
# is exclusive with the field peerGcpGateway.
# Corresponds to the JSON property `peerExternalGateway`
# @return [String]
attr_accessor :peer_external_gateway
# The interface ID of the external VPN gateway to which this VPN tunnel is
# connected. Provided by the client when the VPN tunnel is created.
# Corresponds to the JSON property `peerExternalGatewayInterface`
# @return [Fixnum]
attr_accessor :peer_external_gateway_interface
# URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected.
# Provided by the client when the VPN tunnel is created. This field can be used
# when creating highly available VPN from VPC network to VPC network, the field
# is exclusive with the field peerExternalGateway. If provided, the VPN tunnel
# will automatically use the same vpnGatewayInterface ID in the peer GCP VPN
# gateway.
# Corresponds to the JSON property `peerGcpGateway`
# @return [String]
attr_accessor :peer_gcp_gateway
# IP address of the peer VPN gateway. Only IPv4 is supported.
# Corresponds to the JSON property `peerIp`
# @return [String]
attr_accessor :peer_ip
# [Output Only] URL of the region where the VPN tunnel resides. You must specify
# this field as part of the HTTP request URL. It is not settable as a field in
# the request body.
# Corresponds to the JSON property `region`
# @return [String]
attr_accessor :region
# Remote traffic selectors to use when establishing the VPN tunnel with the peer
# VPN gateway. The value should be a CIDR formatted string, for example: 192.168.
# 0.0/16. The ranges should be disjoint. Only IPv4 is supported.
# Corresponds to the JSON property `remoteTrafficSelector`
# @return [Array<String>]
attr_accessor :remote_traffic_selector
# URL of the router resource to be used for dynamic routing.
# Corresponds to the JSON property `router`
# @return [String]
attr_accessor :router
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# Shared secret used to set the secure session between the Cloud VPN gateway and
# the peer VPN gateway.
# Corresponds to the JSON property `sharedSecret`
# @return [String]
attr_accessor :shared_secret
# Hash of the shared secret.
# Corresponds to the JSON property `sharedSecretHash`
# @return [String]
attr_accessor :shared_secret_hash
# [Output Only] The status of the VPN tunnel, which can be one of the following:
# - PROVISIONING: Resource is being allocated for the VPN tunnel.
# - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the
# user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route
# resources are needed to setup the VPN tunnel.
# - FIRST_HANDSHAKE: Successful first handshake with the peer VPN.
# - ESTABLISHED: Secure session is successfully established with the peer VPN.
# - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS
# - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret).
# - NEGOTIATION_FAILURE: Handshake failed.
# - DEPROVISIONING: Resources are being deallocated for the VPN tunnel.
# - FAILED: Tunnel creation has failed and the tunnel is not ready to be used.
# - NO_INCOMING_PACKETS: No incoming packets from peer.
# - REJECTED: Tunnel configuration was rejected, can be result of being
# blacklisted.
# - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required
# resources.
# - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for
# Classic VPN tunnels or the project is in frozen state.
# - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably
# behind NAT.
# - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-
# VPN tunnel.
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
# URL of the Target VPN gateway with which this VPN tunnel is associated.
# Provided by the client when the VPN tunnel is created.
# Corresponds to the JSON property `targetVpnGateway`
# @return [String]
attr_accessor :target_vpn_gateway
# URL of the VPN gateway with which this VPN tunnel is associated. Provided by
# the client when the VPN tunnel is created. This must be used (instead of
# target_vpn_gateway) if a High Availability VPN gateway resource is created.
# Corresponds to the JSON property `vpnGateway`
# @return [String]
attr_accessor :vpn_gateway
# The interface ID of the VPN gateway with which this VPN tunnel is associated.
# Corresponds to the JSON property `vpnGatewayInterface`
# @return [Fixnum]
attr_accessor :vpn_gateway_interface
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@description = args[:description] if args.key?(:description)
@detailed_status = args[:detailed_status] if args.key?(:detailed_status)
@id = args[:id] if args.key?(:id)
@ike_version = args[:ike_version] if args.key?(:ike_version)
@kind = args[:kind] if args.key?(:kind)
@local_traffic_selector = args[:local_traffic_selector] if args.key?(:local_traffic_selector)
@name = args[:name] if args.key?(:name)
@peer_external_gateway = args[:peer_external_gateway] if args.key?(:peer_external_gateway)
@peer_external_gateway_interface = args[:peer_external_gateway_interface] if args.key?(:peer_external_gateway_interface)
@peer_gcp_gateway = args[:peer_gcp_gateway] if args.key?(:peer_gcp_gateway)
@peer_ip = args[:peer_ip] if args.key?(:peer_ip)
@region = args[:region] if args.key?(:region)
@remote_traffic_selector = args[:remote_traffic_selector] if args.key?(:remote_traffic_selector)
@router = args[:router] if args.key?(:router)
@self_link = args[:self_link] if args.key?(:self_link)
@shared_secret = args[:shared_secret] if args.key?(:shared_secret)
@shared_secret_hash = args[:shared_secret_hash] if args.key?(:shared_secret_hash)
@status = args[:status] if args.key?(:status)
@target_vpn_gateway = args[:target_vpn_gateway] if args.key?(:target_vpn_gateway)
@vpn_gateway = args[:vpn_gateway] if args.key?(:vpn_gateway)
@vpn_gateway_interface = args[:vpn_gateway_interface] if args.key?(:vpn_gateway_interface)
end
end
#
class VpnTunnelAggregatedList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of VpnTunnelsScopedList resources.
# Corresponds to the JSON property `items`
# @return [Hash<String,Google::Apis::ComputeV1::VpnTunnelsScopedList>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::VpnTunnelAggregatedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::VpnTunnelAggregatedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Contains a list of VpnTunnel resources.
class VpnTunnelList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of VpnTunnel resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::VpnTunnel>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::VpnTunnelList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::VpnTunnelList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class VpnTunnelsScopedList
include Google::Apis::Core::Hashable
# A list of VPN tunnels contained in this scope.
# Corresponds to the JSON property `vpnTunnels`
# @return [Array<Google::Apis::ComputeV1::VpnTunnel>]
attr_accessor :vpn_tunnels
# Informational warning which replaces the list of addresses when the list is
# empty.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::VpnTunnelsScopedList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@vpn_tunnels = args[:vpn_tunnels] if args.key?(:vpn_tunnels)
@warning = args[:warning] if args.key?(:warning)
end
# Informational warning which replaces the list of addresses when the list is
# empty.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::VpnTunnelsScopedList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class WafExpressionSet
include Google::Apis::Core::Hashable
# A list of alternate IDs. The format should be: - E.g. XSS-stable Generic
# suffix like "stable" is particularly useful if a policy likes to avail newer
# set of expressions without having to change the policy. A given alias name can'
# t be used for more than one entity set.
# Corresponds to the JSON property `aliases`
# @return [Array<String>]
attr_accessor :aliases
# List of available expressions.
# Corresponds to the JSON property `expressions`
# @return [Array<Google::Apis::ComputeV1::WafExpressionSetExpression>]
attr_accessor :expressions
# Google specified expression set ID. The format should be: - E.g. XSS-20170329
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@aliases = args[:aliases] if args.key?(:aliases)
@expressions = args[:expressions] if args.key?(:expressions)
@id = args[:id] if args.key?(:id)
end
end
#
class WafExpressionSetExpression
include Google::Apis::Core::Hashable
# Expression ID should uniquely identify the origin of the expression. E.g.
# owasp-crs-v020901-id973337 identifies Owasp core rule set version 2.9.1 rule
# id 973337. The ID could be used to determine the individual attack definition
# that has been detected. It could also be used to exclude it from the policy in
# case of false positive.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
end
end
# In contrast to a single BackendService in HttpRouteAction to which all
# matching traffic is directed to, WeightedBackendService allows traffic to be
# split across multiple BackendServices. The volume of traffic for each
# BackendService is proportional to the weight specified in each
# WeightedBackendService
class WeightedBackendService
include Google::Apis::Core::Hashable
# The full or partial URL to the default BackendService resource. Before
# forwarding the request to backendService, the loadbalancer applies any
# relevant headerActions specified as part of this backendServiceWeight.
# Corresponds to the JSON property `backendService`
# @return [String]
attr_accessor :backend_service
# The request and response header transformations that take effect before the
# request is passed along to the selected backendService.
# Corresponds to the JSON property `headerAction`
# @return [Google::Apis::ComputeV1::HttpHeaderAction]
attr_accessor :header_action
# Specifies the fraction of traffic sent to backendService, computed as weight /
# (sum of all weightedBackendService weights in routeAction) .
# The selection of a backend service is determined only for new traffic. Once a
# user's request has been directed to a backendService, subsequent requests will
# be sent to the same backendService as determined by the BackendService's
# session affinity policy.
# The value must be between 0 and 1000
# Corresponds to the JSON property `weight`
# @return [Fixnum]
attr_accessor :weight
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@backend_service = args[:backend_service] if args.key?(:backend_service)
@header_action = args[:header_action] if args.key?(:header_action)
@weight = args[:weight] if args.key?(:weight)
end
end
#
class XpnHostList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# [Output Only] A list of shared VPC host project URLs.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::Project>]
attr_accessor :items
# [Output Only] Type of resource. Always compute#xpnHostList for lists of shared
# VPC hosts.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::XpnHostList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::XpnHostList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
# Service resource (a.k.a service project) ID.
class XpnResourceId
include Google::Apis::Core::Hashable
# The ID of the service resource. In the case of projects, this field supports
# project id (e.g., my-project-123) and project number (e.g. 12345678).
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# The type of the service resource.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@type = args[:type] if args.key?(:type)
end
end
# Represents a Zone resource.
# A zone is a deployment area. These deployment areas are subsets of a region.
# For example the zone us-east1-a is located in the us-east1 region. For more
# information, read Regions and Zones. (== resource_for `$api_version`.zones ==)
class Zone
include Google::Apis::Core::Hashable
# [Output Only] Available cpu/platform selections for the zone.
# Corresponds to the JSON property `availableCpuPlatforms`
# @return [Array<String>]
attr_accessor :available_cpu_platforms
# [Output Only] Creation timestamp in RFC3339 text format.
# Corresponds to the JSON property `creationTimestamp`
# @return [String]
attr_accessor :creation_timestamp
# Deprecation status for a public resource.
# Corresponds to the JSON property `deprecated`
# @return [Google::Apis::ComputeV1::DeprecationStatus]
attr_accessor :deprecated
# [Output Only] Textual description of the resource.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# [Output Only] The unique identifier for the resource. This identifier is
# defined by the server.
# Corresponds to the JSON property `id`
# @return [Fixnum]
attr_accessor :id
# [Output Only] Type of the resource. Always compute#zone for zones.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] Name of the resource.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# [Output Only] Full URL reference to the region which hosts the zone.
# Corresponds to the JSON property `region`
# @return [String]
attr_accessor :region
# [Output Only] Server-defined URL for the resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Status of the zone, either UP or DOWN.
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@available_cpu_platforms = args[:available_cpu_platforms] if args.key?(:available_cpu_platforms)
@creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
@deprecated = args[:deprecated] if args.key?(:deprecated)
@description = args[:description] if args.key?(:description)
@id = args[:id] if args.key?(:id)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@region = args[:region] if args.key?(:region)
@self_link = args[:self_link] if args.key?(:self_link)
@status = args[:status] if args.key?(:status)
end
end
# Contains a list of zone resources.
class ZoneList
include Google::Apis::Core::Hashable
# [Output Only] Unique identifier for the resource; defined by the server.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of Zone resources.
# Corresponds to the JSON property `items`
# @return [Array<Google::Apis::ComputeV1::Zone>]
attr_accessor :items
# Type of resource.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# [Output Only] This token allows you to get the next page of results for list
# requests. If the number of results is larger than maxResults, use the
# nextPageToken as a value for the query parameter pageToken in the next list
# request. Subsequent list requests will have their own nextPageToken to
# continue paging through the results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# [Output Only] Server-defined URL for this resource.
# Corresponds to the JSON property `selfLink`
# @return [String]
attr_accessor :self_link
# [Output Only] Informational warning message.
# Corresponds to the JSON property `warning`
# @return [Google::Apis::ComputeV1::ZoneList::Warning]
attr_accessor :warning
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@id = args[:id] if args.key?(:id)
@items = args[:items] if args.key?(:items)
@kind = args[:kind] if args.key?(:kind)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@self_link = args[:self_link] if args.key?(:self_link)
@warning = args[:warning] if args.key?(:warning)
end
# [Output Only] Informational warning message.
class Warning
include Google::Apis::Core::Hashable
# [Output Only] A warning code, if applicable. For example, Compute Engine
# returns NO_RESULTS_ON_PAGE if there are no results in the response.
# Corresponds to the JSON property `code`
# @return [String]
attr_accessor :code
# [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ ` "key": "scope", "value": "zones/us-east1-d" `
# Corresponds to the JSON property `data`
# @return [Array<Google::Apis::ComputeV1::ZoneList::Warning::Datum>]
attr_accessor :data
# [Output Only] A human-readable description of the warning code.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@data = args[:data] if args.key?(:data)
@message = args[:message] if args.key?(:message)
end
#
class Datum
include Google::Apis::Core::Hashable
# [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).
# Corresponds to the JSON property `key`
# @return [String]
attr_accessor :key
# [Output Only] A warning data value corresponding to the key.
# Corresponds to the JSON property `value`
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key = args[:key] if args.key?(:key)
@value = args[:value] if args.key?(:value)
end
end
end
end
#
class ZoneSetLabelsRequest
include Google::Apis::Core::Hashable
# The fingerprint of the previous set of labels for this resource, used to
# detect conflicts. 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.
# Make a get() request to the resource to get the latest fingerprint.
# Corresponds to the JSON property `labelFingerprint`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :label_fingerprint
# The labels to set for this resource.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint)
@labels = args[:labels] if args.key?(:labels)
end
end
#
class ZoneSetPolicyRequest
include Google::Apis::Core::Hashable
# Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use '
# policy' to specify bindings.
# Corresponds to the JSON property `bindings`
# @return [Array<Google::Apis::ComputeV1::Binding>]
attr_accessor :bindings
# Flatten Policy to create a backward compatible wire-format. Deprecated. Use '
# policy' to specify the etag.
# Corresponds to the JSON property `etag`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :etag
# An Identity and Access Management (IAM) policy, which specifies access
# controls for Google Cloud resources.
# A `Policy` is a collection of `bindings`. A `binding` binds one or more `
# members` to a single `role`. Members can be user accounts, service accounts,
# Google groups, and domains (such as G Suite). A `role` is a named list of
# permissions; each `role` can be an IAM predefined role or a user-created
# custom role.
# For some types of Google Cloud resources, a `binding` can also specify a `
# condition`, which is a logical expression that allows access to a resource
# only if the expression evaluates to `true`. A condition can add constraints
# based on attributes of the request, the resource, or both. To learn which
# resources support conditions in their IAM policies, see the [IAM documentation]
# (https://cloud.google.com/iam/help/conditions/resource-policies).
# **JSON example:**
# ` "bindings": [ ` "role": "roles/resourcemanager.organizationAdmin", "members":
# [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "
# serviceAccount:my-project-id@appspot.gserviceaccount.com" ] `, ` "role": "
# roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com"
# ], "condition": ` "title": "expirable access", "description": "Does not grant
# access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:
# 00:00.000Z')", ` ` ], "etag": "BwWWja0YfJA=", "version": 3 `
# **YAML example:**
# bindings: - members: - user:mike@example.com - group:admins@example.com -
# domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com
# role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.
# com role: roles/resourcemanager.organizationViewer condition: title: expirable
# access description: Does not grant access after Sep 2020 expression: request.
# time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3
# For a description of IAM and its features, see the [IAM documentation](https://
# cloud.google.com/iam/docs/).
# Corresponds to the JSON property `policy`
# @return [Google::Apis::ComputeV1::Policy]
attr_accessor :policy
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@bindings = args[:bindings] if args.key?(:bindings)
@etag = args[:etag] if args.key?(:etag)
@policy = args[:policy] if args.key?(:policy)
end
end
end
end
end
Reference in New Issue View Git Blame Copy Permalink