ComputeFunctions

Functions

Link copied to clipboard

Get the IP address from a static address. For more information see the official API documentation.

suspend fun getAddress(argument: suspend GetAddressPlainArgsBuilder.() -> Unit): GetAddressResult
suspend fun getAddress(name: String, project: String? = null, region: String? = null): GetAddressResult
Link copied to clipboard

List IP addresses in a project. For more information see the official API list and aggregated list documentation.

suspend fun getAddresses(filter: String? = null, project: String? = null, region: String? = null): GetAddressesResult
Link copied to clipboard

Get information about a BackendBucket.

suspend fun getBackendBucket(name: String, project: String? = null): GetBackendBucketResult
Link copied to clipboard

Provide access to a Backend Service's attribute. For more information see the official documentation and the API.

suspend fun getBackendService(name: String, project: String? = null): GetBackendServiceResult
Link copied to clipboard

Get info about a Google Compute SSL Certificate from its name.

suspend fun getCertificate(name: String, project: String? = null): GetCertificateResult
Link copied to clipboard

Use this data source to retrieve default service account for this project

Link copied to clipboard
suspend fun getDisk(argument: GetDiskPlainArgs): GetDiskResult

Get information about a Google Compute Persistent disks. the official documentation and its API.

suspend fun getDisk(argument: suspend GetDiskPlainArgsBuilder.() -> Unit): GetDiskResult
suspend fun getDisk(name: String, project: String? = null, zone: String? = null): GetDiskResult
Link copied to clipboard

Retrieves the current IAM policy data for disk

suspend fun getDiskIamPolicy(name: String, project: String? = null, zone: String? = null): GetDiskIamPolicyResult
Link copied to clipboard

Get a forwarding rule within GCE from its name.

suspend fun getForwardingRule(name: String, project: String? = null, region: String? = null): GetForwardingRuleResult
Link copied to clipboard

List all networks in a specified Google Cloud project.

suspend fun getForwardingRules(project: String? = null, region: String? = null): GetForwardingRulesResult
Link copied to clipboard

Get the IP address from a static address reserved for a Global Forwarding Rule which are only used for HTTP load balancing. For more information see the official API documentation.

suspend fun getGlobalAddress(name: String, project: String? = null): GetGlobalAddressResult
Link copied to clipboard

Get a global forwarding rule within GCE from its name.

Link copied to clipboard

Get a HA VPN Gateway within GCE from its name.

suspend fun getHcVpnGateway(name: String, project: String? = null, region: String? = null): GetHcVpnGatewayResult
Link copied to clipboard

Get information about a HealthCheck.

suspend fun getHealthCheck(name: String, project: String? = null): GetHealthCheckResult
Link copied to clipboard
suspend fun getImage(argument: GetImagePlainArgs): GetImageResult

Get information about a Google Compute Image. Check that your service account has the compute.imageUser role if you want to share custom images from another project. If you want to use pubimg, do not forget to specify the dedicated project. For more information see the official documentation and its API.

suspend fun getImage(argument: suspend GetImagePlainArgsBuilder.() -> Unit): GetImageResult
suspend fun getImage(family: String? = null, filter: String? = null, mostRecent: Boolean? = null, name: String? = null, project: String? = null): GetImageResult
Link copied to clipboard

Retrieves the current IAM policy data for image

suspend fun getImageIamPolicy(image: String, project: String? = null): GetImageIamPolicyResult
Link copied to clipboard

Get information about Google Compute Images. Check that your service account has the compute.imageUser role if you want to share custom images from another project. If you want to use pubimg, do not forget to specify the dedicated project. For more information see the official documentation and its API.

suspend fun getImages(argument: suspend GetImagesPlainArgsBuilder.() -> Unit): GetImagesResult
suspend fun getImages(filter: String? = null, project: String? = null): GetImagesResult
Link copied to clipboard

Get information about a VM instance resource within GCE. For more information see the official documentation and API.

suspend fun getInstance(argument: suspend GetInstancePlainArgsBuilder.() -> Unit): GetInstanceResult
suspend fun getInstance(name: String? = null, project: String? = null, selfLink: String? = null, zone: String? = null): GetInstanceResult
Link copied to clipboard

Get a Compute Instance Group within GCE. For more information, see the official documentation and API

suspend fun getInstanceGroup(name: String? = null, project: String? = null, selfLink: String? = null, zone: String? = null): GetInstanceGroupResult
Link copied to clipboard

Get a Compute Instance Group Manager within GCE. For more information, see the official documentation and API

suspend fun getInstanceGroupManager(name: String? = null, project: String? = null, selfLink: String? = null, zone: String? = null): GetInstanceGroupManagerResult
Link copied to clipboard

Get information about a VM instance resource within GCE. For more information see the official documentation and API. Get information about VM's guest attrubutes. For more information see the official documentation and API.

suspend fun getInstanceGuestAttributes(name: String, project: String? = null, queryPath: String? = null, region: String? = null, variableKey: String? = null, zone: String? = null): GetInstanceGuestAttributesResult
Link copied to clipboard

Retrieves the current IAM policy data for instance

suspend fun getInstanceIamPolicy(instanceName: String, project: String? = null, zone: String? = null): GetInstanceIamPolicyResult
Link copied to clipboard

Get the serial port output from a Compute Instance. For more information see the official API documentation.

suspend fun getInstanceSerialPort(instance: String, port: Int, project: String? = null, zone: String? = null): GetInstanceSerialPortResult
Link copied to clipboard
suspend fun getInstanceTemplate(filter: String? = null, mostRecent: Boolean? = null, name: String? = null, project: String? = null, selfLinkUnique: String? = null): GetInstanceTemplateResult
Link copied to clipboard
Link copied to clipboard

Use this data source to access IP ranges in your firewall rules. https://cloud.google.com/compute/docs/load-balancing/health-checks#health_check_source_ips_and_firewall_rules

Link copied to clipboard

Provides access to available Google Compute machine types in a zone for a given project. See more about machine type availability in the upstream docs. To get more information about machine types, see:

suspend fun getMachineTypes(filter: String? = null, project: String? = null, zone: String? = null): GetMachineTypesResult
Link copied to clipboard

Use this data source to get the IP addresses from different special IP ranges on Google Cloud Platform.

suspend fun getNetblockIPRanges(rangeType: String? = null): GetNetblockIPRangesResult
Link copied to clipboard

Get a network within GCE from its name.

suspend fun getNetwork(argument: suspend GetNetworkPlainArgsBuilder.() -> Unit): GetNetworkResult
suspend fun getNetwork(name: String, networkProfile: String? = null, project: String? = null): GetNetworkResult
Link copied to clipboard

Use this data source to access a Network Endpoint Group's attributes. The NEG may be found by providing either a self_link, or a name and a zone.

suspend fun getNetworkEndpointGroup(name: String? = null, project: String? = null, selfLink: String? = null, zone: String? = null): GetNetworkEndpointGroupResult
Link copied to clipboard

Get information of a specified compute network peering. For more information see the official documentation and API.

Link copied to clipboard

List all networks in a specified Google Cloud project.

suspend fun getNetworks(project: String? = null): GetNetworksResult
suspend fun getNetworks(argument: suspend GetNetworksPlainArgsBuilder.() -> Unit): GetNetworksResult
Link copied to clipboard

Provides available node types for Compute Engine sole-tenant nodes in a zone for a given project. For more information, see the official documentation and API.

suspend fun getNodeTypes(project: String? = null, zone: String? = null): GetNodeTypesResult
Link copied to clipboard

Get information about a Regional Backend Service. For more information see the official documentation and API.

suspend fun getRegionBackendService(name: String, project: String? = null, region: String? = null): GetRegionBackendServiceResult
Link copied to clipboard

Get information about a Google Compute Regional Persistent disks. the official documentation and its API.

suspend fun getRegionDisk(name: String, project: String? = null, region: String? = null): GetRegionDiskResult
Link copied to clipboard

Retrieves the current IAM policy data for regiondisk

suspend fun getRegionDiskIamPolicy(name: String, project: String? = null, region: String? = null): GetRegionDiskIamPolicyResult
Link copied to clipboard

Get a Compute Region Instance Group within GCE. For more information, see the official documentation and API.

suspend fun getRegionInstanceGroup(name: String? = null, project: String? = null, region: String? = null, selfLink: String? = null): GetRegionInstanceGroupResult
Link copied to clipboard

Get a Compute Region Instance Group Manager within GCE. For more information, see the official documentation and API

suspend fun getRegionInstanceGroupManager(name: String? = null, project: String? = null, region: String? = null, selfLink: String? = null): GetRegionInstanceGroupManagerResult
Link copied to clipboard

Get information about a VM instance template resource within GCE. For more information see the official documentation and API.

suspend fun getRegionInstanceTemplate(filter: String? = null, mostRecent: Boolean? = null, name: String? = null, project: String? = null, region: String? = null): GetRegionInstanceTemplateResult
Link copied to clipboard

Use this data source to access a Region Network Endpoint Group's attributes. The RNEG may be found by providing either a self_link, or a name and a region.

suspend fun getRegionNetworkEndpointGroup(name: String? = null, project: String? = null, region: String? = null, selfLink: String? = null): GetRegionNetworkEndpointGroupResult
Link copied to clipboard

Provides access to available Google Compute regions for a given project. See more about regions and zones in the upstream docs.

suspend fun getRegions(argument: suspend GetRegionsPlainArgsBuilder.() -> Unit): GetRegionsResult
suspend fun getRegions(project: String? = null, status: String? = null): GetRegionsResult
Link copied to clipboard

Get info about a Region Google Compute SSL Certificate from its name.

suspend fun getRegionSslCertificate(name: String, project: String? = null, region: String? = null): GetRegionSslCertificateResult
Link copied to clipboard
Link copied to clipboard

Provides access to available Google Compute Reservation Resources for a given project. See more about Reservations of Compute Engine resources in the upstream docs.

suspend fun getReservation(name: String, project: String? = null, zone: String): GetReservationResult
Link copied to clipboard

Provide access to a Resource Policy's attributes. For more information see the official documentation or the API.

suspend fun getResourcePolicy(name: String, project: String? = null, region: String? = null): GetResourcePolicyResult
Link copied to clipboard

Get a router within GCE from its name and VPC.

suspend fun getRouter(argument: suspend GetRouterPlainArgsBuilder.() -> Unit): GetRouterResult
suspend fun getRouter(name: String, network: String, project: String? = null, region: String? = null): GetRouterResult
Link copied to clipboard

To get more information about Snapshot, see:

suspend fun getRouterNat(name: String, project: String? = null, region: String? = null, router: String): GetRouterNatResult
Link copied to clipboard

Get a Cloud Router's status within GCE from its name and region. This data source exposes the routes learned by a Cloud Router via BGP peers. For more information see the official documentation and API.

suspend fun getRouterStatus(name: String, project: String? = null, region: String? = null): GetRouterStatusResult
Link copied to clipboard

To get more information about Google Compute Security Policy, see:

suspend fun getSecurityPolicy(name: String? = null, project: String? = null, selfLink: String? = null): GetSecurityPolicyResult
Link copied to clipboard

To get more information about Snapshot, see:

suspend fun getSnapshot(argument: suspend GetSnapshotPlainArgsBuilder.() -> Unit): GetSnapshotResult

suspend fun getSnapshot(filter: String? = null, mostRecent: Boolean? = null, name: String? = null, project: String? = null): GetSnapshotResult

/*

Link copied to clipboard

Retrieves the current IAM policy data for snapshot

suspend fun getSnapshotIamPolicy(name: String, project: String? = null): GetSnapshotIamPolicyResult
Link copied to clipboard

Gets an SSL Policy within GCE from its name, for use with Target HTTPS and Target SSL Proxies. For more information see the official documentation.

suspend fun getSSLPolicy(name: String, project: String? = null): GetSSLPolicyResult
Link copied to clipboard

Retrieves the current IAM policy data for storagepool

suspend fun getStoragePoolIamPolicy(name: String, project: String? = null, zone: String? = null): GetStoragePoolIamPolicyResult
Link copied to clipboard

Get a subnetwork within GCE from its name and region.

suspend fun getSubnetwork(name: String? = null, project: String? = null, region: String? = null, selfLink: String? = null): GetSubnetworkResult
Link copied to clipboard

Retrieves the current IAM policy data for subnetwork

suspend fun getSubnetworkIamPolicy(project: String? = null, region: String? = null, subnetwork: String): GetSubnetworkIamPolicyResult
Link copied to clipboard

Get subnetworks within GCE. See the official documentation and API.

suspend fun getSubnetworks(filter: String? = null, project: String? = null, region: String? = null): GetSubnetworksResult
Link copied to clipboard

Get a VPN gateway within GCE from its name.

suspend fun getVPNGateway(name: String, project: String? = null, region: String? = null): GetVPNGatewayResult
Link copied to clipboard
suspend fun getZones(argument: GetZonesPlainArgs): GetZonesResult

Provides access to available Google Compute zones in a region for a given project. See more about regions and zones in the upstream docs.

suspend fun getZones(argument: suspend GetZonesPlainArgsBuilder.() -> Unit): GetZonesResult
suspend fun getZones(project: String? = null, region: String? = null, status: String? = null): GetZonesResult
Link copied to clipboard

Get a Cloud Router's status within GCE from its name and region. This data source exposes the routes learned by a Cloud Router via BGP peers. For more information see the official documentation and API.

suspend fun RouterStatus(name: String, project: String? = null, region: String? = null): RouterStatusResult