google_api_compute v0.2.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 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 ==)
[Output Only] Informational warning message
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 ==)
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 ==)
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
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 ==)
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
Deprecation status for a public resource
A Disk resource. (== resource_for beta.disks ==) (== resource_for v1.disks ==)
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
A DiskType resource. (== resource_for beta.diskTypes ==) (== resource_for v1.diskTypes ==)
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
Contains a list of firewalls
The available logging options for a firewall rule
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 ==)
Contains a list of ForwardingRule resources
Informational warning which replaces the list of forwarding rules when the list is empty
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
UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService
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 ==)
InstanceGroups (== resource_for beta.instanceGroups ==) (== resource_for v1.instanceGroups ==) (== resource_for beta.regionInstanceGroups ==) (== resource_for v1.regionInstanceGroups ==)
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 ==)
[Output Only] A list of managed instance groups
[Output Only] The warning that replaces the list of managed instance groups when the list is empty
[Output Only] An informational warning that replaces the list of instance groups when the list is empty
Contains a list of instances
Contains a list of instance referrers
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
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 ==)
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
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
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 ==)
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
A metadata key/value entry
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 ==)
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
A NodeGroup resource
Contains a list of nodeGroups
[Output Only] An informational warning that appears when the nodeGroup list is empty
A Node Template resource
Contains a list of node templates
[Output Only] An informational warning that appears when the node templates list is empty
A Node Type resource
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 ==)
[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 ==)
A quotas entry
Represents a reference to a resource
Region resource. (== resource_for beta.regions ==) (== resource_for v1.regions ==)
Contains a list of autoscalers
Contains a list of InstanceGroup resources
Contains a list of managed instance groups
Contains a list of region resources
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
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
Status of a NAT contained in this router
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 ==)
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
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
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 ==)
Contains a list of Subnetwork resources
Represents a secondary IP range of a subnetwork
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 ==)
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 ==)
Contains a list of TargetPool resources
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 ==)
Contains a list of TargetVpnGateway resources
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
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 ==)
Contains a list of VpnTunnel resources
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
Helper functions for building Tesla requests