Package-level declarations
Types
A specification of the type and number of accelerator cards attached to the instance.
Builder for AcceleratorConfigArgs.
An access configuration attached to an instance's network interface. Only one access config per instance is supported.
Builder for AccessConfigArgs.
Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled).
Builder for AdvancedMachineFeaturesArgs.
An alias IP range attached to an instance's network interface.
Builder for AliasIpRangeArgs.
Properties of the SKU instances being reserved. Next ID: 9
This reservation type allows to pre allocate specific instance configuration. Next ID: 6
An instance-attached disk resource.
Builder for AttachedDiskArgs.
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 field is persisted and returned for instanceTemplate and not returned in the context of instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both.
Builder for AttachedDiskInitializeParamsArgs.
Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices
and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": "user:aliya@example.com" } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
Builder for AuditConfigArgs.
Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
Builder for AuditLogConfigArgs.
This is deprecated and has no effect. Do not use.
Builder for AuthorizationLoggingOptionsArgs.
Cloud Autoscaler policy.
Builder for AutoscalingPolicyArgs.
CPU utilization policy.
Custom utilization metric policy.
Configuration parameters of autoscaling based on load balancing.
Configuration that allows for slower scale in so that even if Autoscaler recommends an abrupt scale in of a MIG, it will be throttled as specified by the parameters below.
Message containing information of one individual backend.
Builder for BackendArgs.
Message containing Cloud CDN configuration for a backend bucket.
Builder for BackendBucketCdnPolicyArgs.
Bypass the cache when the specified request headers are present, e.g. Pragma or Authorization headers. Values are case insensitive. The presence of such a header overrides the cache_mode setting.
Message containing what to include in the cache key for a request for Cloud CDN.
Specify CDN TTLs for response error codes.
Message containing Cloud CDN configuration for a backend service.
Builder for BackendServiceCdnPolicyArgs.
Bypass the cache when the specified request headers are present, e.g. Pragma or Authorization headers. Values are case insensitive. The presence of such a header overrides the cache_mode setting.
Specify CDN TTLs for response error codes.
Connection Tracking configuration for this BackendService.
For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing. On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes).
Builder for BackendServiceFailoverPolicyArgs.
Identity-Aware Proxy
Builder for BackendServiceIAPArgs.
Container for either a built-in LB policy supported by gRPC or Envoy or a custom one implemented by the end user.
The configuration for a custom policy implemented by the user and deployed with the client.
The configuration for a built-in load balancing policy.
The available logging options for the load balancer traffic served by this backend service.
Builder for BackendServiceLogConfigArgs.
Builder for BindingArgs.
Message containing what to include in the cache key for a request for Cloud CDN.
Builder for CacheKeyPolicyArgs.
Settings controlling the volume of requests, connections and retries to this backend service.
Builder for CircuitBreakersArgs.
This is deprecated and has no effect. Do not use.
Builder for ConditionArgs.
A set of Confidential Instance options.
Builder for ConfidentialInstanceConfigArgs.
Message containing connection draining configuration.
Builder for ConnectionDrainingArgs.
This message defines settings for a consistent hash style load balancer.
The information about the HTTP Cookie on which the hash function is based for load balancing policies that use a consistent hash.
The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard.
Builder for CorsPolicyArgs.
Builder for CustomerEncryptionKeyArgs.
Deprecation status for a public resource.
Builder for DeprecationStatusArgs.
Builder for DiskAsyncReplicationArgs.
A specification of the desired way to instantiate a disk in the instance template when its created from a source instance.
Builder for DiskInstantiationConfigArgs.
Additional disk params.
Builder for DiskParamsArgs.
A set of Display Device options
Builder for DisplayDeviceArgs.
Builder for DistributionPolicyArgs.
A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years.
Builder for DurationArgs.
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
Builder for ExprArgs.
The interface for the external VPN gateway.
Builder for ExternalVpnGatewayInterfaceArgs.
Builder for FileContentBufferArgs.
Builder for FirewallAllowedItemArgs.
Builder for FirewallDeniedItemArgs.
The available logging options for a firewall rule.
Builder for FirewallLogConfigArgs.
Builder for FirewallPolicyAssociationArgs.
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).
Builder for FirewallPolicyRuleArgs.
Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified.
Builder for FirewallPolicyRuleMatcherArgs.
Builder for FirewallPolicyRuleSecureTagArgs.
Encapsulates numeric value that can be either absolute or relative.
Builder for FixedOrPercentArgs.
Describes the auto-registration of the Forwarding Rule to Service Directory. The region and project of the Service Directory resource generated from this registration will be the same as this Forwarding Rule.
Builder for GetAddressPlainArgs.
Builder for GetAutoscalerPlainArgs.
Builder for GetBackendBucketPlainArgs.
Builder for GetBackendServicePlainArgs.
Builder for GetDiskIamPolicyPlainArgs.
Builder for GetDiskPlainArgs.
Builder for GetExternalVpnGatewayPlainArgs.
Builder for GetFirewallPlainArgs.
Builder for GetFirewallPolicyPlainArgs.
Builder for GetForwardingRulePlainArgs.
Builder for GetGlobalAddressPlainArgs.
Builder for GetGlobalForwardingRulePlainArgs.
Builder for GetHealthCheckPlainArgs.
Builder for GetHttpHealthCheckPlainArgs.
Builder for GetHttpsHealthCheckPlainArgs.
Builder for GetImageIamPolicyPlainArgs.
Builder for GetImagePlainArgs.
Builder for GetInstanceGroupManagerPlainArgs.
Builder for GetInstanceGroupPlainArgs.
Builder for GetInstanceIamPolicyPlainArgs.
Builder for GetInstancePlainArgs.
Builder for GetInstanceTemplatePlainArgs.
Builder for GetInterconnectAttachmentPlainArgs.
Builder for GetInterconnectPlainArgs.
Builder for GetLicenseIamPolicyPlainArgs.
Builder for GetLicensePlainArgs.
Builder for GetMachineImageIamPolicyPlainArgs.
Builder for GetMachineImagePlainArgs.
Builder for GetNetworkAttachmentPlainArgs.
Builder for GetNetworkEndpointGroupPlainArgs.
Builder for GetNetworkFirewallPolicyPlainArgs.
Builder for GetNetworkPlainArgs.
Builder for GetNodeGroupIamPolicyPlainArgs.
Builder for GetNodeGroupPlainArgs.
Builder for GetNodeTemplateIamPolicyPlainArgs.
Builder for GetNodeTemplatePlainArgs.
Builder for GetPacketMirroringPlainArgs.
Builder for GetPublicAdvertisedPrefixPlainArgs.
Builder for GetPublicDelegatedPrefixPlainArgs.
Builder for GetRegionAutoscalerPlainArgs.
Builder for GetRegionBackendServicePlainArgs.
Builder for GetRegionCommitmentPlainArgs.
Builder for GetRegionDiskIamPolicyPlainArgs.
Builder for GetRegionDiskPlainArgs.
Builder for GetRegionHealthCheckPlainArgs.
Builder for GetRegionInstanceTemplatePlainArgs.
Builder for GetRegionSecurityPolicyPlainArgs.
Builder for GetRegionSslCertificatePlainArgs.
Builder for GetRegionSslPolicyPlainArgs.
Builder for GetRegionTargetHttpProxyPlainArgs.
Builder for GetRegionTargetHttpsProxyPlainArgs.
Builder for GetRegionTargetTcpProxyPlainArgs.
Builder for GetRegionUrlMapPlainArgs.
Builder for GetReservationIamPolicyPlainArgs.
Builder for GetReservationPlainArgs.
Builder for GetResourcePolicyPlainArgs.
Builder for GetRoutePlainArgs.
Builder for GetRouterPlainArgs.
Builder for GetSecurityPolicyPlainArgs.
Builder for GetServiceAttachmentPlainArgs.
Builder for GetSnapshotIamPolicyPlainArgs.
Builder for GetSnapshotPlainArgs.
Builder for GetSslCertificatePlainArgs.
Builder for GetSslPolicyPlainArgs.
Builder for GetSubnetworkIamPolicyPlainArgs.
Builder for GetSubnetworkPlainArgs.
Builder for GetTargetGrpcProxyPlainArgs.
Builder for GetTargetHttpProxyPlainArgs.
Builder for GetTargetHttpsProxyPlainArgs.
Builder for GetTargetInstancePlainArgs.
Builder for GetTargetPoolPlainArgs.
Builder for GetTargetSslProxyPlainArgs.
Builder for GetTargetTcpProxyPlainArgs.
Builder for GetTargetVpnGatewayPlainArgs.
Builder for GetUrlMapPlainArgs.
Builder for GetVpnGatewayPlainArgs.
Builder for GetVpnTunnelPlainArgs.
Builder for GRPCHealthCheckArgs.
Guest OS features.
Builder for GuestOsFeatureArgs.
Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver.
Builder for HealthCheckLogConfigArgs.
UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.
Builder for HostRuleArgs.
Builder for HTTP2HealthCheckArgs.
Specification for how requests are aborted as part of fault injection.
Builder for HttpFaultAbortArgs.
Specifies the delay introduced by the load balancer before forwarding the request to the backend service as part of fault injection.
Builder for HttpFaultDelayArgs.
The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by the load balancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the load balancer for a percentage of requests.
Builder for HttpFaultInjectionArgs.
The request and response header transformations that take effect before the request is passed along to the selected backendService.
Builder for HttpHeaderActionArgs.
matchRule criteria for request header matches.
Builder for HttpHeaderMatchArgs.
Specification determining how headers are added to requests or responses.
Builder for HttpHeaderOptionArgs.
Builder for HTTPHealthCheckArgs.
HttpRouteRuleMatch criteria for a request's query parameter.
Builder for HttpQueryParameterMatchArgs.
Specifies settings for an HTTP redirect.
Builder for HttpRedirectActionArgs.
The retry policy associates with HttpRouteRule
Builder for HttpRetryPolicyArgs.
Builder for HttpRouteActionArgs.
The HttpRouteRule setting specifies how to match an HTTP request and the corresponding routing action that load balancing proxies perform.
Builder for HttpRouteRuleArgs.
HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.
Builder for HttpRouteRuleMatchArgs.
Builder for HTTPSHealthCheckArgs.
The parameters of the raw disk image.
Builder for ImageRawDiskArgs.
Initial State for shielded instance, these are public keys which are safe to store in public
Builder for InitialStateConfigArgs.
Builder for InstanceGroupManagerVersionArgs.
Additional instance params.
Builder for InstanceParamsArgs.
Builder for InstancePropertiesArgs.
HttpRouteRuleMatch criteria for field values that must stay within the specified integer range.
Builder for Int64RangeMatchArgs.
Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments.
Commitment for a particular license resource.
Builder for LicenseResourceCommitmentArgs.
Builder for LicenseResourceRequirementsArgs.
Builder for LocalDiskArgs.
This is deprecated and has no effect. Do not use.
Builder for LogConfigArgs.
This is deprecated and has no effect. Do not use.
Builder for LogConfigCloudAuditOptionsArgs.
This is deprecated and has no effect. Do not use.
Builder for LogConfigCounterOptionsArgs.
This is deprecated and has no effect. Do not use.
This is deprecated and has no effect. Do not use.
Builder for LogConfigDataAccessOptionsArgs.
A metadata key/value entry.
Builder for MetadataArgs.
Opaque filter criteria used by load balancers to restrict routing configuration to a limited set of load balancing proxies. Proxies and sidecars involved in load balancing would typically present metadata to the load balancers that need to match criteria specified here. If a match takes place, the relevant configuration is made available to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. An example for using metadataFilters would be: if load balancing involves Envoys, they receive routing configuration when values in metadataFilters match values supplied in of their XDS requests to loadbalancers.
Builder for MetadataFilterArgs.
MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the load balancer.
Builder for MetadataFilterLabelMatchArgs.
Metadata
Builder for MetadataItemsItemArgs.
The named port. For example: <"http", 80>.
Builder for NamedPortArgs.
Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG.
Builder for NetworkEndpointGroupAppEngineArgs.
Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG.
Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG.
Builder for NetworkEndpointGroupCloudRunArgs.
All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT.
Builder for NetworkEndpointGroupPscDataArgs.
A network interface resource attached to an instance.
Builder for NetworkInterfaceArgs.
Builder for NetworkPerformanceConfigArgs.
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.
Builder for NetworkRoutingConfigArgs.
Builder for NodeGroupAutoscalingPolicyArgs.
Time window specified for daily maintenance operations. GCE's internal maintenance will be performed within this window.
Builder for NodeGroupMaintenanceWindowArgs.
Represents a gRPC setting that describes one gRPC notification endpoint and the retry duration attempting to send notification to this endpoint.
Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service.
Builder for OutlierDetectionArgs.
Builder for PacketMirroringFilterArgs.
Builder for PacketMirroringNetworkInfoArgs.
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 is used.
Builder for PathMatcherArgs.
A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.
Builder for PathRuleArgs.
Represents a sub PublicDelegatedPrefix.
A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer doesn't wait for responses from the shadow service. Before sending traffic to the shadow service, the host or authority header is suffixed with -shadow.
Builder for RequestMirrorPolicyArgs.
Specifies the reservations that this instance can consume from.
Builder for ReservationAffinityArgs.
Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources.
Builder for ReservationArgs.
Commitment for a particular resource (a Commitment is composed of one or more of these).
Builder for ResourceCommitmentArgs.
Time window specified for daily operations.
Builder for ResourcePolicyDailyCycleArgs.
A GroupPlacementPolicy specifies resource placement configuration. It specifies the failure bucket separation as well as network locality
Time window specified for hourly operations.
Builder for ResourcePolicyHourlyCycleArgs.
An InstanceSchedulePolicy specifies when and how frequent certain operations are performed on the instance.
Schedule for an instance operation.
A snapshot schedule policy specifies when and how frequently snapshots are to be created for the target disk. Also specifies how many and how long these scheduled snapshots should be retained.
Policy for retention of scheduled snapshots.
A schedule for disks where the schedueled operations are performed.
Specified snapshot properties for scheduled snapshots created by this policy.
Time window specified for weekly operations.
Builder for ResourcePolicyWeeklyCycleArgs.
Description-tagged IP ranges for the router to advertise.
Builder for RouterAdvertisedIpRangeArgs.
Builder for RouterBgpArgs.
Builder for RouterBgpPeerArgs.
Builder for RouterBgpPeerBfdArgs.
Builder for RouterInterfaceArgs.
Builder for RouterMd5AuthenticationKeyArgs.
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.
Builder for RouterNatArgs.
Configuration of logging on a NAT.
Builder for RouterNatLogConfigArgs.
Builder for RouterNatRuleActionArgs.
Builder for RouterNatRuleArgs.
Defines the IP ranges that want to use NAT for a subnetwork.
Builder for RouterNatSubnetworkToNatArgs.
This is deprecated and has no effect. Do not use.
Builder for RuleArgs.
An instance-attached disk resource.
Builder for SavedDiskArgs.
Sets the scheduling options for an Instance.
Builder for SchedulingArgs.
Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.
Builder for SchedulingNodeAffinityArgs.
Configuration options for Cloud Armor Adaptive Protection (CAAP).
Configuration options for L7 DDoS detection. This field is only supported in Global Security Policies of type CLOUD_ARMOR.
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).
Builder for SecurityPolicyRuleArgs.
Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified.
Builder for SecurityPolicyRuleMatcherArgs.
The authentication and authorization settings for a BackendService.
Builder for SecuritySettingsArgs.
Builder for ServerBindingArgs.
A service account.
Builder for ServiceAccountArgs.
The share setting for reservations and sole tenancy node groups.
Builder for ShareSettingsArgs.
A set of Shielded Instance options.
Builder for ShieldedInstanceConfigArgs.
The policy describes the baseline against which Instance boot integrity is measured.
Builder for SourceDiskEncryptionKeyArgs.
A specification of the parameters to use when creating the instance template from a source instance.
Builder for SourceInstanceParamsArgs.
Configuration and status of a managed SSL certificate.
Configuration and status of a self-managed SSL certificate.
Builder for SSLHealthCheckArgs.
Builder for StatefulPolicyArgs.
Configuration of preserved resources.
Builder for StatefulPolicyPreservedStateArgs.
The available logging options for this subnetwork.
Builder for SubnetworkLogConfigArgs.
Represents a secondary IP range of a subnetwork.
Builder for SubnetworkSecondaryRangeArgs.
Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director.
Builder for SubsettingArgs.
Builder for TagsArgs.
Builder for TCPHealthCheckArgs.
Message for the expected URL mappings.
Builder for UrlMapTestArgs.
HTTP headers used in UrlMapTests.
Builder for UrlMapTestHeaderArgs.
The spec for modifying the path before sending the request to the matched backend service.
Builder for UrlRewriteArgs.
A VPN gateway interface.
Builder for VpnGatewayVpnGatewayInterfaceArgs.
In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple backend services. The volume of traffic for each backend service is proportional to the weight specified in each WeightedBackendService
Builder for WeightedBackendServiceArgs.