google_api_compute v0.6.0 API Reference
Modules
API calls for all endpoints tagged AcceleratorTypes
.
API calls for all endpoints tagged Addresses
.
API calls for all endpoints tagged Autoscalers
.
API calls for all endpoints tagged BackendBuckets
.
API calls for all endpoints tagged BackendServices
.
API calls for all endpoints tagged DiskTypes
.
API calls for all endpoints tagged Disks
.
API calls for all endpoints tagged Firewalls
.
API calls for all endpoints tagged ForwardingRules
.
API calls for all endpoints tagged GlobalAddresses
.
API calls for all endpoints tagged GlobalForwardingRules
.
API calls for all endpoints tagged GlobalOperations
.
API calls for all endpoints tagged HealthChecks
.
API calls for all endpoints tagged HttpHealthChecks
.
API calls for all endpoints tagged HttpsHealthChecks
.
API calls for all endpoints tagged Images
.
API calls for all endpoints tagged InstanceGroupManagers
.
API calls for all endpoints tagged InstanceGroups
.
API calls for all endpoints tagged InstanceTemplates
.
API calls for all endpoints tagged Instances
.
API calls for all endpoints tagged InterconnectAttachments
.
API calls for all endpoints tagged InterconnectLocations
.
API calls for all endpoints tagged Interconnects
.
API calls for all endpoints tagged LicenseCodes
.
API calls for all endpoints tagged Licenses
.
API calls for all endpoints tagged MachineTypes
.
API calls for all endpoints tagged NetworkEndpointGroups
.
API calls for all endpoints tagged Networks
.
API calls for all endpoints tagged NodeGroups
.
API calls for all endpoints tagged NodeTemplates
.
API calls for all endpoints tagged NodeTypes
.
API calls for all endpoints tagged Projects
.
API calls for all endpoints tagged RegionAutoscalers
.
API calls for all endpoints tagged RegionBackendServices
.
API calls for all endpoints tagged RegionCommitments
.
API calls for all endpoints tagged RegionDiskTypes
.
API calls for all endpoints tagged RegionDisks
.
API calls for all endpoints tagged RegionInstanceGroupManagers
.
API calls for all endpoints tagged RegionInstanceGroups
.
API calls for all endpoints tagged RegionOperations
.
API calls for all endpoints tagged Regions
.
API calls for all endpoints tagged Routers
.
API calls for all endpoints tagged Routes
.
API calls for all endpoints tagged SecurityPolicies
.
API calls for all endpoints tagged Snapshots
.
API calls for all endpoints tagged SslCertificates
.
API calls for all endpoints tagged SslPolicies
.
API calls for all endpoints tagged Subnetworks
.
API calls for all endpoints tagged TargetHttpProxies
.
API calls for all endpoints tagged TargetHttpsProxies
.
API calls for all endpoints tagged TargetInstances
.
API calls for all endpoints tagged TargetPools
.
API calls for all endpoints tagged TargetSslProxies
.
API calls for all endpoints tagged TargetTcpProxies
.
API calls for all endpoints tagged TargetVpnGateways
.
API calls for all endpoints tagged UrlMaps
.
API calls for all endpoints tagged VpnTunnels
.
API calls for all endpoints tagged ZoneOperations
.
API calls for all endpoints tagged Zones
.
Handle Tesla connections for GoogleApi.Compute.V1.
Helper functions for deserializing responses into models.
A specification of the type and number of accelerator cards attached to the instance.
An Accelerator Type resource. (== resource_for beta.acceleratorTypes ==) (== resource_for v1.acceleratorTypes ==)
Attributes
- id (String.t): [Output Only] Unique identifier for the resource; defined by the server. Defaults to:
null
. - items (%{optional(String.t) => AcceleratorTypesScopedList}): A list of AcceleratorTypesScopedList resources. Defaults to:
null
. - kind (String.t): [Output Only] Type of resource. Always compute#acceleratorTypeAggregatedList for aggregated lists of accelerator types. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for this resource. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
[Output Only] Informational warning message.
Attributes
- key (String.t): [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). Defaults to:
null
. - value (String.t): [Output Only] A warning data value corresponding to the key. Defaults to:
null
.
Contains a list of accelerator types.
[Output Only] An informational warning that appears when the accelerator types list is empty.
An access configuration attached to an instance's network interface. Only one access config per instance is supported.
A reserved address resource. (== resource_for beta.addresses ==) (== resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== resource_for v1.globalAddresses ==)
Attributes
- id (String.t): [Output Only] Unique identifier for the resource; defined by the server. Defaults to:
null
. - items (%{optional(String.t) => AddressesScopedList}): A list of AddressesScopedList resources. Defaults to:
null
. - kind (String.t): [Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for this resource. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
Contains a list of addresses.
[Output Only] Informational warning which replaces the list of addresses when the list is empty.
An alias IP range attached to an instance's network interface.
An instance-attached disk resource.
[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.
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:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "fooservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:bar@gmail.com" ] } ] } ] } For fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts foo@gmail.com from DATA_READ logging, and bar@gmail.com from DATA_WRITE logging.
Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:foo@gmail.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting foo@gmail.com from DATA_READ logging.
Authorization-related information used by Cloud Audit Logging.
Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define. For more information, read Autoscaling Groups of Instances. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==)
Attributes
- id (String.t): [Output Only] Unique identifier for the resource; defined by the server. Defaults to:
null
. - items (%{optional(String.t) => AutoscalersScopedList}): A list of AutoscalersScopedList resources. Defaults to:
null
. - kind (String.t): [Output Only] Type of resource. Always compute#autoscalerAggregatedList for aggregated lists of autoscalers. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for this resource. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
Contains a list of Autoscaler resources.
[Output Only] Informational warning which replaces the list of autoscalers when the list is empty.
Cloud Autoscaler policy.
CPU utilization policy.
Custom utilization metric policy.
Configuration parameters of autoscaling based on load balancing.
Message containing information of one individual backend.
A BackendBucket resource. This resource defines a Cloud Storage bucket.
Message containing Cloud CDN configuration for a backend bucket.
Contains a list of BackendBucket resources.
A BackendService resource. This resource defines a group of backend virtual machines and their serving capacity. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==)
Contains a list of BackendServicesScopedList.
Message containing Cloud CDN configuration for a backend service.
Attributes
- healthStatus ([HealthStatus]): Health state of the backend instances or endpoints in requested instance or network endpoint group, determined based on configured health checks. Defaults to:
null
. - kind (String.t): [Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services. Defaults to:
null
.
Identity-Aware Proxy
Contains a list of BackendService resources.
Informational warning which replaces the list of backend services when the list is empty.
Associates `members` with a `role`.
Message containing what to include in the cache key for a request for Cloud CDN.
Represents a 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. Committed use discounts are subject to Google Cloud Platform's Service Specific Terms. By purchasing a committed use discount, you agree to these terms. Committed use discounts will not renew, so you must purchase a new commitment to continue receiving discounts. (== resource_for beta.commitments ==) (== resource_for v1.commitments ==)
Attributes
- id (String.t): [Output Only] Unique identifier for the resource; defined by the server. Defaults to:
null
. - items (%{optional(String.t) => CommitmentsScopedList}): A list of CommitmentsScopedList resources. Defaults to:
null
. - kind (String.t): [Output Only] Type of resource. Always compute#commitmentAggregatedList for aggregated lists of commitments. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for this resource. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
Contains a list of Commitment resources.
[Output Only] Informational warning which replaces the list of commitments when the list is empty.
A condition to be met.
Message containing connection draining configuration.
Represents a customer-supplied encryption key
Attributes
- diskEncryptionKey (CustomerEncryptionKey): Decrypts data associated with the disk with a customer-supplied encryption key. Defaults to:
null
. - source (String.t): Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Defaults to:
null
.
Deprecation status for a public resource.
A Disk resource. (== resource_for beta.disks ==) (== resource_for v1.disks ==)
Attributes
- id (String.t): [Output Only] Unique identifier for the resource; defined by the server. Defaults to:
null
. - items (%{optional(String.t) => DisksScopedList}): A list of DisksScopedList resources. Defaults to:
null
. - kind (String.t): [Output Only] Type of resource. Always compute#diskAggregatedList for aggregated lists of persistent disks. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for this resource. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
A specification of the desired way to instantiate a disk in the instance template when its created from a source instance.
A list of Disk resources.
Attributes
- destinationZone (String.t): 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 Defaults to:
null
. - targetDisk (String.t): 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 Defaults to:
null
.
A DiskType resource. (== resource_for beta.diskTypes ==) (== resource_for v1.diskTypes ==)
Attributes
- id (String.t): [Output Only] Unique identifier for the resource; defined by the server. Defaults to:
null
. - items (%{optional(String.t) => DiskTypesScopedList}): A list of DiskTypesScopedList resources. Defaults to:
null
. - kind (String.t): [Output Only] Type of resource. Always compute#diskTypeAggregatedList. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for this resource. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
Contains a list of disk types.
[Output Only] Informational warning which replaces the list of disk types when the list is empty.
[Output Only] Informational warning which replaces the list of disks when the list is empty.
Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0"
Represents a Firewall resource.
Attributes
- IPProtocol (String.t): 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. Defaults to:
null
. - ports ([String.t]): An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. Defaults to:
null
.
Contains a list of firewalls.
The available logging options for a firewall rule.
Encapsulates numeric value that can be either absolute or relative.
A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, ports] tuple. (== resource_for beta.forwardingRules ==) (== resource_for v1.forwardingRules ==) (== resource_for beta.globalForwardingRules ==) (== resource_for v1.globalForwardingRules ==) (== resource_for beta.regionForwardingRules ==) (== resource_for v1.regionForwardingRules ==)
Attributes
- id (String.t): [Output Only] Unique identifier for the resource; defined by the server. Defaults to:
null
. - items (%{optional(String.t) => ForwardingRulesScopedList}): A list of ForwardingRulesScopedList resources. Defaults to:
null
. - kind (String.t): [Output Only] Type of resource. Always compute#forwardingRuleAggregatedList for lists of forwarding rules. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for this resource. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
Contains a list of ForwardingRule resources.
Informational warning which replaces the list of forwarding rules when the list is empty.
Attributes
- labelFingerprint (binary()): 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. Defaults to:
null
. - labels (%{optional(String.t) => String.t}): 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?` 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": ""). Defaults to:
null
.
Attributes
- bindings ([Binding]): Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. Defaults to:
null
. - etag (binary()): Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. Defaults to:
null
. - policy (Policy): REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. Defaults to:
null
.
Guest OS features.
An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.
Contains a list of HealthCheck resources.
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
Attributes
- backendService (BackendServiceReference): URL of the backend service associated with the health state of the network endpoint. Defaults to:
null
. - forwardingRule (ForwardingRuleReference): URL of the forwarding rule associated with the health state of the network endpoint. Defaults to:
null
. - healthCheck (HealthCheckReference): URL of the health check associated with the health state of the network endpoint. Defaults to:
null
. healthState (String.t): Health state of the network endpoint determined based on the health checks configured. Defaults to:
null
.
UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
Attributes
- host (String.t): 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. Defaults to:
null
. - port (integer()): The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. Defaults to:
null
. - portName (String.t): Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. Defaults to:
null
. portSpecification (String.t): 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. Defaults to:
null
.
An HttpHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTP.
Contains a list of HttpHealthCheck resources.
An HttpsHealthCheck resource. This resource defines a template for how individual instances should be checked for health, via HTTPS.
Contains a list of HttpsHealthCheck resources.
An Image resource. (== resource_for beta.images ==) (== resource_for v1.images ==)
Contains a list of images.
The parameters of the raw disk image.
An Instance resource. (== resource_for beta.instances ==) (== resource_for v1.instances ==)
Attributes
- id (String.t): [Output Only] Unique identifier for the resource; defined by the server. Defaults to:
null
. - items (%{optional(String.t) => InstancesScopedList}): A list of InstancesScopedList resources. Defaults to:
null
. - kind (String.t): [Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for this resource. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
InstanceGroups (== resource_for beta.instanceGroups ==) (== resource_for v1.instanceGroups ==) (== resource_for beta.regionInstanceGroups ==) (== resource_for v1.regionInstanceGroups ==)
Attributes
- id (String.t): [Output Only] Unique identifier for the resource; defined by the server. Defaults to:
null
. - items (%{optional(String.t) => InstanceGroupsScopedList}): A list of InstanceGroupsScopedList resources. Defaults to:
null
. - kind (String.t): [Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for this resource. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
A list of InstanceGroup resources.
An Instance Group Manager resource. (== resource_for beta.instanceGroupManagers ==) (== resource_for v1.instanceGroupManagers ==) (== resource_for beta.regionInstanceGroupManagers ==) (== resource_for v1.regionInstanceGroupManagers ==)
Attributes
- abandoning (integer()): [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. Defaults to:
null
. - creating (integer()): [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. Defaults to:
null
. - creatingWithoutRetries (integer()): [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. Defaults to:
null
. - deleting (integer()): [Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted. Defaults to:
null
. - none (integer()): [Output Only] The number of instances in the managed instance group that are running and have no scheduled actions. Defaults to:
null
. - recreating (integer()): [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. Defaults to:
null
. - refreshing (integer()): [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. Defaults to:
null
. - restarting (integer()): [Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted. Defaults to:
null
. - verifying (integer()): [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. Defaults to:
null
.
Attributes
- id (String.t): [Output Only] Unique identifier for the resource; defined by the server. Defaults to:
null
. - items (%{optional(String.t) => InstanceGroupManagersScopedList}): A list of InstanceGroupManagersScopedList resources. Defaults to:
null
. - kind (String.t): [Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for this resource. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
Attributes
- healthCheck (String.t): The URL for the health check that signals autohealing. Defaults to:
null
. - initialDelaySec (integer()): 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]. Defaults to:
null
.
[Output Only] A list of managed instance groups.
Attributes
- isStable (boolean()): [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. Defaults to:
null
.
Attributes
- maxSurge (FixedOrPercent): The maximum number of instances that can be created above the specified targetSize during the update process. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge. Defaults to:
null
. - maxUnavailable (FixedOrPercent): The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied: - The instance's status is RUNNING. - If there is a health check on the instance group, the instance's liveness health check result must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary. At least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable. Defaults to:
null
. minimalAction (String.t): 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. Defaults to:
null
.
Attributes
- instanceTemplate (String.t): Defaults to:
null
. - name (String.t): Name of the version. Unique among all versions in the scope of this managed instance group. Defaults to:
null
. - targetSize (FixedOrPercent): Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to: - If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used. - if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded up. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information. Defaults to:
null
.
[Output Only] The warning that replaces the list of managed instance groups when the list is empty.
Attributes
- fingerprint (binary()): 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. Defaults to:
null
. - targetPools ([String.t]): 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. Defaults to:
null
.
Attributes
- id (String.t): [Output Only] Unique identifier for the resource; defined by the server. Defaults to:
null
. - items ([InstanceWithNamedPorts]): A list of InstanceWithNamedPorts resources. Defaults to:
null
. - kind (String.t): [Output Only] The resource type, which is always compute#instanceGroupsListInstances for the list of instances in the specified instance group. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for this resource. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
[Output Only] An informational warning that replaces the list of instance groups when the list is empty.
Attributes
- fingerprint (binary()): 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. Defaults to:
null
. - namedPorts ([NamedPort]): The list of named ports to set for this instance group. Defaults to:
null
.
Contains a list of instances.
Contains a list of instance referrers.
Attributes
- destinationZone (String.t): 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 Defaults to:
null
. - targetInstance (String.t): 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 Defaults to:
null
.
Attributes
- tags (Tags): A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035. Defaults to:
null
. - canIpForward (boolean()): Enables instances created based on this template 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. Defaults to:
null
. - description (String.t): An optional text description for the instances that are created from this instance template. Defaults to:
null
. - disks ([AttachedDisk]): An array of disks that are associated with the instances that are created from this template. Defaults to:
null
. - guestAccelerators ([AcceleratorConfig]): A list of guest accelerator cards' type and count to use for instances created from the instance template. Defaults to:
null
. - labels (%{optional(String.t) => String.t}): Labels to apply to instances that are created from this template. Defaults to:
null
. - machineType (String.t): The machine type to use for instances that are created from this template. Defaults to:
null
. - metadata (Metadata): The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information. Defaults to:
null
. - minCpuPlatform (String.t): Minimum cpu/platform to be used by this instance. 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. Defaults to:
null
. - networkInterfaces ([NetworkInterface]): An array of network access configurations for this interface. Defaults to:
null
. - scheduling (Scheduling): Specifies the scheduling options for the instances that are created from this template. Defaults to:
null
. - serviceAccounts ([ServiceAccount]): A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances. Defaults to:
null
. - shieldedInstanceConfig (ShieldedInstanceConfig): Defaults to:
null
.
An Instance Template resource. (== resource_for beta.instanceTemplates ==) (== resource_for v1.instanceTemplates ==)
A list of instance templates.
[Output Only] Informational warning which replaces the list of instances when the list is empty.
Attributes
- disks ([CustomerEncryptionKeyProtectedDisk]): 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. Defaults to:
null
.
Represents an Interconnects resource. The Interconnects resource is a dedicated connection between Google's network and your on-premises network. For more information, see the Dedicated overview page. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==)
Represents an InterconnectAttachment (VLAN attachment) resource. For more information, see Creating VLAN Attachments. (== resource_for beta.interconnectAttachments ==) (== resource_for v1.interconnectAttachments ==)
Attributes
- id (String.t): [Output Only] Unique identifier for the resource; defined by the server. Defaults to:
null
. - items (%{optional(String.t) => InterconnectAttachmentsScopedList}): A list of InterconnectAttachmentsScopedList resources. Defaults to:
null
. - kind (String.t): [Output Only] Type of resource. Always compute#interconnectAttachmentAggregatedList for aggregated lists of interconnect attachments. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for this resource. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
Response to the list request, and contains a list of interconnect attachments.
Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments.
Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED.
Informational warning which replaces the list of addresses when the list is empty.
Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only. Next id: 4
Diagnostics information about interconnect, contains detailed and current technical information about Google?s side of the connection.
Describing the ARP neighbor entries seen on this link
Attributes
state (String.t): 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. Defaults to:
null
.
Attributes
- arpCaches ([InterconnectDiagnosticsArpEntry]): A list of InterconnectDiagnostics.ARPEntry objects, describing the ARP neighbor entries seen on this link. This will be empty if the link is bundled Defaults to:
null
. - circuitId (String.t): The unique ID for this link assigned during turn up by Google. Defaults to:
null
. - googleDemarc (String.t): The Demarc address assigned by Google and provided in the LoA. Defaults to:
null
. - lacpStatus (InterconnectDiagnosticsLinkLacpStatus): Defaults to:
null
. - receivingOpticalPower (InterconnectDiagnosticsLinkOpticalPower): An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the received light level. Defaults to:
null
. - transmittingOpticalPower (InterconnectDiagnosticsLinkOpticalPower): An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the transmitted light level. Defaults to:
null
.
Response to the list request, and contains a list of interconnects.
Represents an InterconnectLocations resource. The InterconnectLocations resource describes the locations where you can connect to Google's networks. For more information, see Colocation Facilities.
Response to the list request, and contains a list of interconnect locations.
Information about any potential InterconnectAttachments between an Interconnect at a specific InterconnectLocation, and a specific Cloud Region.
Description of a planned outage on this Interconnect. Next id: 9
Response for the InterconnectsGetDiagnosticsRequest.
A license resource.
Attributes
- creationTimestamp (String.t): [Output Only] Creation timestamp in RFC3339 text format. Defaults to:
null
. - description (String.t): [Output Only] Description of this License Code. Defaults to:
null
. - id (String.t): [Output Only] The unique identifier for the resource. This identifier is defined by the server. Defaults to:
null
. - kind (String.t): [Output Only] Type of resource. Always compute#licenseCode for licenses. Defaults to:
null
. - licenseAlias ([LicenseCodeLicenseAlias]): [Output Only] URL and description aliases of Licenses with the same License Code. Defaults to:
null
. - name (String.t): [Output Only] Name of the resource. The name is 1-20 characters long and must be a valid 64 bit integer. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for the resource. Defaults to:
null
. state (String.t): [Output Only] Current state of this License Code. Defaults to:
null
.
Attributes
- minGuestCpuCount (integer()): Minimum number of guest cpus required to use the Instance. Enforced at Instance creation and Instance start. Defaults to:
null
. - minMemoryMb (integer()): Minimum memory required to use the Instance. Enforced at Instance creation and Instance start. Defaults to:
null
.
Attributes
- id (String.t): [Output Only] Unique identifier for the resource; defined by the server. Defaults to:
null
. - items ([License]): A list of License resources. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for this resource. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
Specifies what kind of log the caller must write
Write a Cloud Audit log
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/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support multiple field names (though this may be supported in the future).
Write a Data Access (Gin) log
A Machine Type resource. (== resource_for v1.machineTypes ==) (== resource_for beta.machineTypes ==)
Attributes
- id (String.t): [Output Only] Unique identifier for the resource; defined by the server. Defaults to:
null
. - items (%{optional(String.t) => MachineTypesScopedList}): A list of MachineTypesScopedList resources. Defaults to:
null
. - kind (String.t): [Output Only] Type of resource. Always compute#machineTypeAggregatedList for aggregated lists of machine types. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for this resource. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
Contains a list of machine types.
[Output Only] An informational warning that appears when the machine types list is empty.
A Managed Instance resource.
[Output Only] Encountered errors during the last attempt to create or delete the instance.
Attributes
- code (String.t): [Output Only] The error type identifier for this error. Defaults to:
null
. - location (String.t): [Output Only] Indicates the field in the request that caused the error. This property is optional. Defaults to:
null
. - message (String.t): [Output Only] An optional, human-readable error message. Defaults to:
null
.
A metadata key/value entry.
Attributes
- key (String.t): 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. Defaults to:
null
. - value (String.t): 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). Defaults to:
null
.
The named port. For example: .
Represents a Network resource. Read Virtual Private Cloud (VPC) Network Overview for more information. (== resource_for v1.networks ==) (== resource_for beta.networks ==)
The network endpoint.
Represents a collection of network endpoints.
Attributes
- id (String.t): [Output Only] Unique identifier for the resource; defined by the server. Defaults to:
null
. - items (%{optional(String.t) => NetworkEndpointGroupsScopedList}): A list of NetworkEndpointGroupsScopedList resources. Defaults to:
null
. - kind (String.t): [Output Only] The resource type, which is always compute#networkEndpointGroupAggregatedList for aggregated lists of network endpoint groups. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for this resource. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
Attributes
- id (String.t): [Output Only] Unique identifier for the resource; defined by the server. Defaults to:
null
. - items ([NetworkEndpointGroup]): A list of NetworkEndpointGroup resources. Defaults to:
null
. - kind (String.t): [Output Only] The resource type, which is always compute#networkEndpointGroupList for network endpoint group lists. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for this resource. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
Attributes
- id (String.t): [Output Only] Unique identifier for the resource; defined by the server. Defaults to:
null
. - items ([NetworkEndpointWithHealthStatus]): A list of NetworkEndpointWithHealthStatus resources. Defaults to:
null
. - kind (String.t): [Output Only] The resource type, which is always compute#networkEndpointGroupsListNetworkEndpoints for the list of network endpoints in the specified network endpoint group. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
[Output Only] An informational warning that replaces the list of network endpoint groups when the list is empty.
A network interface resource attached to an instance.
Contains a list of networks.
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.
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.
Attributes
- autoCreateRoutes (boolean()): This field will be deprecated soon. Prefer using exchange_subnet_routes in network_peering instead. Whether Google Compute Engine manages the routes automatically. Defaults to:
null
. - name (String.t): Name of the peering, which should conform to RFC1035. Defaults to:
null
. - networkPeering (NetworkPeering): Network peering parameters. In order to specify route policies for peering using import/export custom routes, you will have to fill all peering related parameters (name, peer network, exchange_subnet_routes) in network_peeringfield. Corresponding fields in NetworksAddPeeringRequest will be deprecated soon. Defaults to:
null
. - peerNetwork (String.t): 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. Defaults to:
null
.
A NodeGroup resource. (== resource_for beta.nodeGroups ==) (== resource_for v1.nodeGroups ==)
Attributes
- id (String.t): [Output Only] Unique identifier for the resource; defined by the server. Defaults to:
null
. - items (%{optional(String.t) => NodeGroupsScopedList}): A list of NodeGroupsScopedList resources. Defaults to:
null
. - kind (String.t): [Output Only] Type of resource.Always compute#nodeGroupAggregatedList for aggregated lists of node groups. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for this resource. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
Contains a list of nodeGroups.
Attributes
- id (String.t): [Output Only] Unique identifier for the resource; defined by the server. Defaults to:
null
. - items ([NodeGroupNode]): A list of Node resources. Defaults to:
null
. - kind (String.t): [Output Only] The resource type, which is always compute.nodeGroupsListNodes for the list of nodes in the specified node group. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for this resource. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
[Output Only] An informational warning that appears when the nodeGroup list is empty.
A Node Template resource.
Attributes
- id (String.t): [Output Only] Unique identifier for the resource; defined by the server. Defaults to:
null
. - items (%{optional(String.t) => NodeTemplatesScopedList}): A list of NodeTemplatesScopedList resources. Defaults to:
null
. - kind (String.t): [Output Only] Type of resource.Always compute#nodeTemplateAggregatedList for aggregated lists of node templates. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for this resource. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
Contains a list of node templates.
[Output Only] An informational warning that appears when the node templates list is empty.
A Node Type resource.
Attributes
- id (String.t): [Output Only] Unique identifier for the resource; defined by the server. Defaults to:
null
. - items (%{optional(String.t) => NodeTypesScopedList}): A list of NodeTypesScopedList resources. Defaults to:
null
. - kind (String.t): [Output Only] Type of resource.Always compute#nodeTypeAggregatedList for aggregated lists of node types. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for this resource. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
Contains a list of node types.
[Output Only] An informational warning that appears when the node types list is empty.
An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
Attributes
- id (String.t): [Output Only] The unique identifier for the resource. This identifier is defined by the server. Defaults to:
null
. - items (%{optional(String.t) => OperationsScopedList}): [Output Only] A map of scoped operation lists. Defaults to:
null
. - kind (String.t): [Output Only] Type of resource. Always compute#operationAggregatedList for aggregated lists of operations. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for this resource. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
[Output Only] If errors are generated during processing of the operation, this field will be populated.
Contains a list of Operation resources.
[Output Only] Informational warning which replaces the list of operations when the list is empty.
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.
A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. JSON Example { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } YAML Example bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the IAM developer's guide.
A Project resource. For an overview of projects, see Cloud Platform Resource Hierarchy. (== resource_for v1.projects ==) (== resource_for beta.projects ==)
Attributes
- kind (String.t): [Output Only] Type of resource. Always compute#projectsGetXpnResources for lists of service resources (a.k.a service projects) Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - resources ([XpnResourceId]): Service resources (a.k.a service projects) attached to this project as their shared VPC host. Defaults to:
null
.
A quotas entry.
Represents a reference to a resource.
Region resource. (== resource_for beta.regions ==) (== resource_for v1.regions ==)
Contains a list of autoscalers.
Attributes
- id (String.t): [Output Only] Unique identifier for the resource; defined by the server. Defaults to:
null
. - items ([DiskType]): A list of DiskType resources. Defaults to:
null
. - kind (String.t): [Output Only] Type of resource. Always compute#regionDiskTypeList for region disk types. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for this resource. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
Contains a list of InstanceGroup resources.
Contains a list of managed instance groups.
Attributes
- fingerprint (binary()): 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. Defaults to:
null
. - targetPools ([String.t]): 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. Defaults to:
null
.
Attributes
- id (String.t): [Output Only] Unique identifier for the resource; defined by the server. Defaults to:
null
. - items ([InstanceWithNamedPorts]): A list of InstanceWithNamedPorts resources. Defaults to:
null
. - kind (String.t): The resource type. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for this resource. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
Attributes
- fingerprint (binary()): 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. Defaults to:
null
. - namedPorts ([NamedPort]): The list of named ports to set for this instance group. Defaults to:
null
.
Contains a list of region resources.
Attributes
- labelFingerprint (binary()): 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. Defaults to:
null
. - labels (%{optional(String.t) => String.t}): The labels to set for this resource. Defaults to:
null
.
Attributes
- bindings ([Binding]): Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. Defaults to:
null
. - etag (binary()): Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. Defaults to:
null
. - policy (Policy): REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. Defaults to:
null
.
Commitment for a particular resource (a Commitment is composed of one or more of these).
Represents a Route resource. A route specifies how certain packets should be handled by the network. Routes are associated with instances by tags and the set of routes for a particular instance is called its routing table. For each packet leaving an instance, the system searches that instance's routing table for a single best matching route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching routes. The packet is then forwarded as specified by the nextHop field of the winning route - either to another instance destination, an instance gateway, or a Google Compute Engine-operated gateway. Packets that do not match any route in the sending instance's routing table are dropped. (== resource_for beta.routes ==) (== resource_for v1.routes ==)
Contains a list of Route resources.
Router resource.
Description-tagged IP ranges for the router to advertise.
Contains a list of routers.
Attributes
- ipRange (String.t): IP address and range of the interface. The IP range must be in the RFC3927 link-local IP 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. Defaults to:
null
. - linkedInterconnectAttachment (String.t): URI of the linked interconnect attachment. It must be in the same region as the router. Each interface can have at most one linked resource and it could either be a VPN Tunnel or an interconnect attachment. Defaults to:
null
. - linkedVpnTunnel (String.t): URI of the linked VPN tunnel. It must be in the same region as the router. Each interface can have at most one linked resource and it could either be a VPN Tunnel or an interconnect attachment. Defaults to:
null
. managementType (String.t): [Output Only] The resource that configures and manages this interface. MANAGED_BY_USER is the default value and can be managed by you or other users; MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google will automatically create, update, and delete this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted. Defaults to:
null
.
Contains a list of Router resources.
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.
Defines the IP ranges that want to use NAT for a subnetwork.
Attributes
- bestRoutes ([Route]): Best routes for this router's network. Defaults to:
null
. - bestRoutesForRouter ([Route]): Best routes learned by this router. Defaults to:
null
. - bgpPeerStatus ([RouterStatusBgpPeerStatus]): Defaults to:
null
. - natStatus ([RouterStatusNatStatus]): Defaults to:
null
. - network (String.t): URI of the network to which this router belongs. Defaults to:
null
.
Attributes
- advertisedRoutes ([Route]): Routes that were advertised to the remote BGP peer Defaults to:
null
. - ipAddress (String.t): IP address of the local BGP interface. Defaults to:
null
. - linkedVpnTunnel (String.t): URL of the VPN tunnel that this BGP peer controls. Defaults to:
null
. - name (String.t): Name of this BGP peer. Unique within the Routers resource. Defaults to:
null
. - numLearnedRoutes (integer()): Number of routes learned from the remote BGP Peer. Defaults to:
null
. - peerIpAddress (String.t): IP address of the remote BGP interface. Defaults to:
null
. - state (String.t): BGP state as specified in RFC1771. Defaults to:
null
. status (String.t): Status of the BGP peer: {UP, DOWN} Defaults to:
null
.
Status of a NAT contained in this router. Next tag: 9
Informational warning which replaces the list of routers when the list is empty.
A rule to be applied in a Policy.
Sets the scheduling options for an Instance.
Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.
A security policy is comprised of one or more rules. It can also be associated with one or more 'targets'. (== resource_for v1.securityPolicies ==) (== resource_for beta.securityPolicies ==)
Attributes
- id (String.t): [Output Only] Unique identifier for the resource; defined by the server. Defaults to:
null
. - items ([SecurityPolicy]): A list of SecurityPolicy resources. Defaults to:
null
. - kind (String.t): [Output Only] Type of resource. Always compute#securityPolicyList for listsof securityPolicies Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
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).
Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified.
An instance's serial console output.
A service account.
A set of Shielded Instance options.
A shielded Instance identity entry.
A Shielded Instance Identity Entry.
The policy describes the baseline against which Instance boot integrity is measured.
Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs
A persistent disk snapshot resource. (== resource_for beta.snapshots ==) (== resource_for v1.snapshots ==)
Contains a list of Snapshot resources.
A specification of the parameters to use when creating the instance template from a source instance.
An SslCertificate resource. This resource provides a mechanism to upload an SSL key and certificate to the load balancer to serve secure connections from the user. (== resource_for beta.sslCertificates ==) (== resource_for v1.sslCertificates ==)
Contains a list of SslCertificate resources.
Attributes
- port (integer()): The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535. Defaults to:
null
. - portName (String.t): Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. Defaults to:
null
. portSpecification (String.t): 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. Defaults to:
null
.
Attributes
- id (String.t): [Output Only] Unique identifier for the resource; defined by the server. Defaults to:
null
. - items ([SslPolicy]): A list of SslPolicy resources. Defaults to:
null
. - kind (String.t): [Output Only] Type of the resource. Always compute#sslPoliciesList for lists of sslPolicies. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for this resource. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
A SSL policy specifies the server-side support for SSL features. This can be attached to a TargetHttpsProxy or a TargetSslProxy. This affects connections between clients and the HTTPS or SSL proxy load balancer. They do not affect the connection between the load balancers and the backends.
A Subnetwork resource. (== resource_for beta.subnetworks ==) (== resource_for v1.subnetworks ==)
Attributes
- id (String.t): [Output Only] Unique identifier for the resource; defined by the server. Defaults to:
null
. - items (%{optional(String.t) => SubnetworksScopedList}): A list of SubnetworksScopedList resources. Defaults to:
null
. - kind (String.t): [Output Only] Type of resource. Always compute#subnetworkAggregatedList for aggregated lists of subnetworks. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for this resource. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
Contains a list of Subnetwork resources.
Represents a secondary IP range of a subnetwork.
Attributes
- ipCidrRange (String.t): 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. Defaults to:
null
.
An informational warning that appears when the list of addresses is empty.
A set of instance tags.
A TargetHttpProxy resource. This resource defines an HTTP proxy. (== resource_for beta.targetHttpProxies ==) (== resource_for v1.targetHttpProxies ==)
A list of TargetHttpProxy resources.
A TargetHttpsProxy resource. This resource defines an HTTPS proxy. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==)
Contains a list of TargetHttpsProxy resources.
A TargetInstance resource. This resource defines an endpoint instance that terminates traffic of certain protocols. (== resource_for beta.targetInstances ==) (== resource_for v1.targetInstances ==)
Attributes
- id (String.t): [Output Only] Unique identifier for the resource; defined by the server. Defaults to:
null
. - items (%{optional(String.t) => TargetInstancesScopedList}): A list of TargetInstance resources. Defaults to:
null
. - kind (String.t): Type of resource. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for this resource. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
Contains a list of TargetInstance resources.
A TargetPool resource. This resource defines a pool of instances, an associated HttpHealthCheck resource, and the fallback target pool. (== resource_for beta.targetPools ==) (== resource_for v1.targetPools ==)
Attributes
- id (String.t): [Output Only] Unique identifier for the resource; defined by the server. Defaults to:
null
. - items (%{optional(String.t) => TargetPoolsScopedList}): A list of TargetPool resources. Defaults to:
null
. - kind (String.t): [Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for this resource. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
Contains a list of TargetPool resources.
Attributes
- instances ([InstanceReference]): 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 Defaults to:
null
.
Attributes
- healthChecks ([HealthCheckReference]): 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 Defaults to:
null
.
A TargetSslProxy resource. This resource defines an SSL proxy. (== resource_for beta.targetSslProxies ==) (== resource_for v1.targetSslProxies ==)
Contains a list of TargetSslProxy resources.
A TargetTcpProxy resource. This resource defines a TCP proxy. (== resource_for beta.targetTcpProxies ==) (== resource_for v1.targetTcpProxies ==)
Contains a list of TargetTcpProxy resources.
Represents a Target VPN gateway resource. (== resource_for beta.targetVpnGateways ==) (== resource_for v1.targetVpnGateways ==)
Attributes
- id (String.t): [Output Only] Unique identifier for the resource; defined by the server. Defaults to:
null
. - items (%{optional(String.t) => TargetVpnGatewaysScopedList}): A list of TargetVpnGateway resources. Defaults to:
null
. - kind (String.t): [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for this resource. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
Contains a list of TargetVpnGateway resources.
Attributes
- port (integer()): The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535. Defaults to:
null
. - portName (String.t): Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. Defaults to:
null
. portSpecification (String.t): 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. Defaults to:
null
.
A UrlMap resource. This resource defines the mapping from URL to the BackendService resource, based on the "longest-match" of the URL's host and path.
Contains a list of UrlMap resources.
Message for the expected URL mappings.
Message representing the validation result for a UrlMap.
Subnetwork which the current user has compute.subnetworks.use permission on.
Secondary IP range of a usable subnetwork.
Attributes
- id (String.t): [Output Only] The unique identifier for the resource. This identifier is defined by the server. Defaults to:
null
. - items ([UsableSubnetwork]): [Output] A list of usable subnetwork URLs. Defaults to:
null
. - kind (String.t): [Output Only] Type of resource. Always compute#usableSubnetworksAggregatedList for aggregated lists of usable subnetworks. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for this resource. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix.
Contain information of Nat mapping for a VM endpoint (i.e., NIC).
Contain information of Nat mapping for an interface of this endpoint.
Contains a list of VmEndpointNatMappings.
VPN tunnel resource. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==)
Attributes
- id (String.t): [Output Only] Unique identifier for the resource; defined by the server. Defaults to:
null
. - items (%{optional(String.t) => VpnTunnelsScopedList}): A list of VpnTunnelsScopedList resources. Defaults to:
null
. - kind (String.t): [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for this resource. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
Contains a list of VpnTunnel resources.
Attributes
- id (String.t): [Output Only] Unique identifier for the resource; defined by the server. Defaults to:
null
. - items ([Project]): [Output Only] A list of shared VPC host project URLs. Defaults to:
null
. - kind (String.t): [Output Only] Type of resource. Always compute#xpnHostList for lists of shared VPC hosts. Defaults to:
null
. - nextPageToken (String.t): [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. Defaults to:
null
. - selfLink (String.t): [Output Only] Server-defined URL for this resource. Defaults to:
null
. - warning (AcceleratorTypeAggregatedListWarning): Defaults to:
null
.
Service resource (a.k.a service project) ID.
A Zone resource. (== resource_for beta.zones ==) (== resource_for v1.zones ==)
Contains a list of zone resources.
Attributes
- labelFingerprint (binary()): 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. Defaults to:
null
. - labels (%{optional(String.t) => String.t}): The labels to set for this resource. Defaults to:
null
.
Attributes
- bindings ([Binding]): Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings. Defaults to:
null
. - etag (binary()): Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. Defaults to:
null
. - policy (Policy): REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. Defaults to:
null
.
Helper functions for building Tesla requests.