com.pulumi.googlenative.compute.v1.ForwardingRuleArgs Maven / Gradle / Ivy
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.googlenative.compute.v1;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import com.pulumi.googlenative.compute.v1.enums.ForwardingRuleIpProtocol;
import com.pulumi.googlenative.compute.v1.enums.ForwardingRuleIpVersion;
import com.pulumi.googlenative.compute.v1.enums.ForwardingRuleLoadBalancingScheme;
import com.pulumi.googlenative.compute.v1.enums.ForwardingRuleNetworkTier;
import com.pulumi.googlenative.compute.v1.enums.ForwardingRulePscConnectionStatus;
import com.pulumi.googlenative.compute.v1.inputs.ForwardingRuleServiceDirectoryRegistrationArgs;
import com.pulumi.googlenative.compute.v1.inputs.MetadataFilterArgs;
import java.lang.Boolean;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class ForwardingRuleArgs extends com.pulumi.resources.ResourceArgs {
public static final ForwardingRuleArgs Empty = new ForwardingRuleArgs();
/**
* This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal and external protocol forwarding. Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive.
*
*/
@Import(name="allPorts")
private @Nullable Output allPorts;
/**
* @return This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal and external protocol forwarding. Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive.
*
*/
public Optional> allPorts() {
return Optional.ofNullable(this.allPorts);
}
/**
* This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If the field is set to TRUE, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer.
*
*/
@Import(name="allowGlobalAccess")
private @Nullable Output allowGlobalAccess;
/**
* @return This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If the field is set to TRUE, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer.
*
*/
public Optional> allowGlobalAccess() {
return Optional.ofNullable(this.allowGlobalAccess);
}
/**
* This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
*
*/
@Import(name="allowPscGlobalAccess")
private @Nullable Output allowPscGlobalAccess;
/**
* @return This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
*
*/
public Optional> allowPscGlobalAccess() {
return Optional.ofNullable(this.allowPscGlobalAccess);
}
/**
* Identifies the backend service to which the forwarding rule sends traffic. Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types.
*
*/
@Import(name="backendService")
private @Nullable Output backendService;
/**
* @return Identifies the backend service to which the forwarding rule sends traffic. Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types.
*
*/
public Optional> backendService() {
return Optional.ofNullable(this.backendService);
}
/**
* An optional description of this resource. Provide this property when you create the resource.
*
*/
@Import(name="description")
private @Nullable Output description;
/**
* @return An optional description of this resource. Provide this property when you create the resource.
*
*/
public Optional> description() {
return Optional.ofNullable(this.description);
}
/**
* IP address for which this forwarding rule accepts traffic. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced target or backendService. While creating a forwarding rule, specifying an IPAddress is required under the following circumstances: - When the target is set to targetGrpcProxy and validateForProxyless is set to true, the IPAddress should be set to 0.0.0.0. - When the target is a Private Service Connect Google APIs bundle, you must specify an IPAddress. Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address. Use one of the following formats to specify an IP address while creating a forwarding rule: * IP address number, as in `100.1.2.3` * IPv6 address range, as in `2600:1234::/96` * Full resource URL, as in https://www.googleapis.com/compute/v1/projects/ project_id/regions/region/addresses/address-name * Partial URL or by name, as in: - projects/project_id/regions/region/addresses/address-name - regions/region/addresses/address-name - global/addresses/address-name - address-name The forwarding rule's target or backendService, and in most cases, also the loadBalancingScheme, determine the type of IP address that you can use. For detailed information, see [IP address specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). When reading an IPAddress, the API always returns the IP address number.
*
*/
@Import(name="ipAddress")
private @Nullable Output ipAddress;
/**
* @return IP address for which this forwarding rule accepts traffic. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced target or backendService. While creating a forwarding rule, specifying an IPAddress is required under the following circumstances: - When the target is set to targetGrpcProxy and validateForProxyless is set to true, the IPAddress should be set to 0.0.0.0. - When the target is a Private Service Connect Google APIs bundle, you must specify an IPAddress. Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address. Use one of the following formats to specify an IP address while creating a forwarding rule: * IP address number, as in `100.1.2.3` * IPv6 address range, as in `2600:1234::/96` * Full resource URL, as in https://www.googleapis.com/compute/v1/projects/ project_id/regions/region/addresses/address-name * Partial URL or by name, as in: - projects/project_id/regions/region/addresses/address-name - regions/region/addresses/address-name - global/addresses/address-name - address-name The forwarding rule's target or backendService, and in most cases, also the loadBalancingScheme, determine the type of IP address that you can use. For detailed information, see [IP address specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). When reading an IPAddress, the API always returns the IP address number.
*
*/
public Optional> ipAddress() {
return Optional.ofNullable(this.ipAddress);
}
/**
* The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in [Load balancing features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends).
*
*/
@Import(name="ipProtocol")
private @Nullable Output ipProtocol;
/**
* @return The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in [Load balancing features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends).
*
*/
public Optional> ipProtocol() {
return Optional.ofNullable(this.ipProtocol);
}
/**
* The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6.
*
*/
@Import(name="ipVersion")
private @Nullable Output ipVersion;
/**
* @return The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6.
*
*/
public Optional> ipVersion() {
return Optional.ofNullable(this.ipVersion);
}
/**
* Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL.
*
*/
@Import(name="isMirroringCollector")
private @Nullable Output isMirroringCollector;
/**
* @return Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL.
*
*/
public Optional> isMirroringCollector() {
return Optional.ofNullable(this.isMirroringCollector);
}
/**
* Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
*
*/
@Import(name="labels")
private @Nullable Output> labels;
/**
* @return Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
*
*/
public Optional>> labels() {
return Optional.ofNullable(this.labels);
}
/**
* Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts.
*
*/
@Import(name="loadBalancingScheme")
private @Nullable Output loadBalancingScheme;
/**
* @return Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts.
*
*/
public Optional> loadBalancingScheme() {
return Optional.ofNullable(this.loadBalancingScheme);
}
/**
* Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not visible to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.
*
*/
@Import(name="metadataFilters")
private @Nullable Output> metadataFilters;
/**
* @return Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not visible to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.
*
*/
public Optional>> metadataFilters() {
return Optional.ofNullable(this.metadataFilters);
}
/**
* Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For Private Service Connect forwarding rules that forward traffic to Google APIs, the forwarding rule name must be a 1-20 characters string with lowercase letters and numbers and must start with a letter.
*
*/
@Import(name="name")
private @Nullable Output name;
/**
* @return Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For Private Service Connect forwarding rules that forward traffic to Google APIs, the forwarding rule name must be a 1-20 characters string with lowercase letters and numbers and must start with a letter.
*
*/
public Optional> name() {
return Optional.ofNullable(this.name);
}
/**
* This field is not used for external load balancing. For Internal TCP/UDP Load Balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If the subnetwork is specified, the network of the subnetwork will be used. If neither subnetwork nor this field is specified, the default network will be used. For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided.
*
*/
@Import(name="network")
private @Nullable Output network;
/**
* @return This field is not used for external load balancing. For Internal TCP/UDP Load Balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If the subnetwork is specified, the network of the subnetwork will be used. If neither subnetwork nor this field is specified, the default network will be used. For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided.
*
*/
public Optional> network() {
return Optional.ofNullable(this.network);
}
/**
* This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address.
*
*/
@Import(name="networkTier")
private @Nullable Output networkTier;
/**
* @return This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address.
*
*/
public Optional> networkTier() {
return Optional.ofNullable(this.networkTier);
}
/**
* This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field.
*
*/
@Import(name="noAutomateDnsZone")
private @Nullable Output noAutomateDnsZone;
/**
* @return This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field.
*
*/
public Optional> noAutomateDnsZone() {
return Optional.ofNullable(this.noAutomateDnsZone);
}
/**
* This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By backend service-based network load balancers, target pool-based network load balancers, internal proxy load balancers, external proxy load balancers, Traffic Director, external protocol forwarding, and Classic VPN. Some products have restrictions on what ports can be used. See port specifications for details. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \\d+(?:-\\d+)?
*
*/
@Import(name="portRange")
private @Nullable Output portRange;
/**
* @return This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By backend service-based network load balancers, target pool-based network load balancers, internal proxy load balancers, external proxy load balancers, Traffic Director, external protocol forwarding, and Classic VPN. Some products have restrictions on what ports can be used. See port specifications for details. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \\d+(?:-\\d+)?
*
*/
public Optional> portRange() {
return Optional.ofNullable(this.portRange);
}
/**
* This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal protocol forwarding. You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. The ports, port_range, and allPorts fields are mutually exclusive. @pattern: \\d+(?:-\\d+)?
*
*/
@Import(name="ports")
private @Nullable Output> ports;
/**
* @return This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal protocol forwarding. You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. The ports, port_range, and allPorts fields are mutually exclusive. @pattern: \\d+(?:-\\d+)?
*
*/
public Optional>> ports() {
return Optional.ofNullable(this.ports);
}
@Import(name="project")
private @Nullable Output project;
public Optional> project() {
return Optional.ofNullable(this.project);
}
@Import(name="pscConnectionStatus")
private @Nullable Output pscConnectionStatus;
public Optional> pscConnectionStatus() {
return Optional.ofNullable(this.pscConnectionStatus);
}
@Import(name="region", required=true)
private Output region;
public Output region() {
return this.region;
}
/**
* An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
*
*/
@Import(name="requestId")
private @Nullable Output requestId;
/**
* @return An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
*
*/
public Optional> requestId() {
return Optional.ofNullable(this.requestId);
}
/**
* Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource.
*
*/
@Import(name="serviceDirectoryRegistrations")
private @Nullable Output> serviceDirectoryRegistrations;
/**
* @return Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource.
*
*/
public Optional>> serviceDirectoryRegistrations() {
return Optional.ofNullable(this.serviceDirectoryRegistrations);
}
/**
* An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing.
*
*/
@Import(name="serviceLabel")
private @Nullable Output serviceLabel;
/**
* @return An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing.
*
*/
public Optional> serviceLabel() {
return Optional.ofNullable(this.serviceLabel);
}
/**
* If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each source_ip_range entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).
*
*/
@Import(name="sourceIpRanges")
private @Nullable Output> sourceIpRanges;
/**
* @return If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each source_ip_range entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).
*
*/
public Optional>> sourceIpRanges() {
return Optional.ofNullable(this.sourceIpRanges);
}
/**
* This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6.
*
*/
@Import(name="subnetwork")
private @Nullable Output subnetwork;
/**
* @return This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6.
*
*/
public Optional> subnetwork() {
return Optional.ofNullable(this.subnetwork);
}
/**
* The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment.
*
*/
@Import(name="target")
private @Nullable Output target;
/**
* @return The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment.
*
*/
public Optional> target() {
return Optional.ofNullable(this.target);
}
private ForwardingRuleArgs() {}
private ForwardingRuleArgs(ForwardingRuleArgs $) {
this.allPorts = $.allPorts;
this.allowGlobalAccess = $.allowGlobalAccess;
this.allowPscGlobalAccess = $.allowPscGlobalAccess;
this.backendService = $.backendService;
this.description = $.description;
this.ipAddress = $.ipAddress;
this.ipProtocol = $.ipProtocol;
this.ipVersion = $.ipVersion;
this.isMirroringCollector = $.isMirroringCollector;
this.labels = $.labels;
this.loadBalancingScheme = $.loadBalancingScheme;
this.metadataFilters = $.metadataFilters;
this.name = $.name;
this.network = $.network;
this.networkTier = $.networkTier;
this.noAutomateDnsZone = $.noAutomateDnsZone;
this.portRange = $.portRange;
this.ports = $.ports;
this.project = $.project;
this.pscConnectionStatus = $.pscConnectionStatus;
this.region = $.region;
this.requestId = $.requestId;
this.serviceDirectoryRegistrations = $.serviceDirectoryRegistrations;
this.serviceLabel = $.serviceLabel;
this.sourceIpRanges = $.sourceIpRanges;
this.subnetwork = $.subnetwork;
this.target = $.target;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(ForwardingRuleArgs defaults) {
return new Builder(defaults);
}
public static final class Builder {
private ForwardingRuleArgs $;
public Builder() {
$ = new ForwardingRuleArgs();
}
public Builder(ForwardingRuleArgs defaults) {
$ = new ForwardingRuleArgs(Objects.requireNonNull(defaults));
}
/**
* @param allPorts This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal and external protocol forwarding. Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive.
*
* @return builder
*
*/
public Builder allPorts(@Nullable Output allPorts) {
$.allPorts = allPorts;
return this;
}
/**
* @param allPorts This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal and external protocol forwarding. Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive.
*
* @return builder
*
*/
public Builder allPorts(Boolean allPorts) {
return allPorts(Output.of(allPorts));
}
/**
* @param allowGlobalAccess This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If the field is set to TRUE, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer.
*
* @return builder
*
*/
public Builder allowGlobalAccess(@Nullable Output allowGlobalAccess) {
$.allowGlobalAccess = allowGlobalAccess;
return this;
}
/**
* @param allowGlobalAccess This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If the field is set to TRUE, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer.
*
* @return builder
*
*/
public Builder allowGlobalAccess(Boolean allowGlobalAccess) {
return allowGlobalAccess(Output.of(allowGlobalAccess));
}
/**
* @param allowPscGlobalAccess This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
*
* @return builder
*
*/
public Builder allowPscGlobalAccess(@Nullable Output allowPscGlobalAccess) {
$.allowPscGlobalAccess = allowPscGlobalAccess;
return this;
}
/**
* @param allowPscGlobalAccess This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
*
* @return builder
*
*/
public Builder allowPscGlobalAccess(Boolean allowPscGlobalAccess) {
return allowPscGlobalAccess(Output.of(allowPscGlobalAccess));
}
/**
* @param backendService Identifies the backend service to which the forwarding rule sends traffic. Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types.
*
* @return builder
*
*/
public Builder backendService(@Nullable Output backendService) {
$.backendService = backendService;
return this;
}
/**
* @param backendService Identifies the backend service to which the forwarding rule sends traffic. Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types.
*
* @return builder
*
*/
public Builder backendService(String backendService) {
return backendService(Output.of(backendService));
}
/**
* @param description An optional description of this resource. Provide this property when you create the resource.
*
* @return builder
*
*/
public Builder description(@Nullable Output description) {
$.description = description;
return this;
}
/**
* @param description An optional description of this resource. Provide this property when you create the resource.
*
* @return builder
*
*/
public Builder description(String description) {
return description(Output.of(description));
}
/**
* @param ipAddress IP address for which this forwarding rule accepts traffic. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced target or backendService. While creating a forwarding rule, specifying an IPAddress is required under the following circumstances: - When the target is set to targetGrpcProxy and validateForProxyless is set to true, the IPAddress should be set to 0.0.0.0. - When the target is a Private Service Connect Google APIs bundle, you must specify an IPAddress. Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address. Use one of the following formats to specify an IP address while creating a forwarding rule: * IP address number, as in `100.1.2.3` * IPv6 address range, as in `2600:1234::/96` * Full resource URL, as in https://www.googleapis.com/compute/v1/projects/ project_id/regions/region/addresses/address-name * Partial URL or by name, as in: - projects/project_id/regions/region/addresses/address-name - regions/region/addresses/address-name - global/addresses/address-name - address-name The forwarding rule's target or backendService, and in most cases, also the loadBalancingScheme, determine the type of IP address that you can use. For detailed information, see [IP address specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). When reading an IPAddress, the API always returns the IP address number.
*
* @return builder
*
*/
public Builder ipAddress(@Nullable Output ipAddress) {
$.ipAddress = ipAddress;
return this;
}
/**
* @param ipAddress IP address for which this forwarding rule accepts traffic. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced target or backendService. While creating a forwarding rule, specifying an IPAddress is required under the following circumstances: - When the target is set to targetGrpcProxy and validateForProxyless is set to true, the IPAddress should be set to 0.0.0.0. - When the target is a Private Service Connect Google APIs bundle, you must specify an IPAddress. Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address. Use one of the following formats to specify an IP address while creating a forwarding rule: * IP address number, as in `100.1.2.3` * IPv6 address range, as in `2600:1234::/96` * Full resource URL, as in https://www.googleapis.com/compute/v1/projects/ project_id/regions/region/addresses/address-name * Partial URL or by name, as in: - projects/project_id/regions/region/addresses/address-name - regions/region/addresses/address-name - global/addresses/address-name - address-name The forwarding rule's target or backendService, and in most cases, also the loadBalancingScheme, determine the type of IP address that you can use. For detailed information, see [IP address specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). When reading an IPAddress, the API always returns the IP address number.
*
* @return builder
*
*/
public Builder ipAddress(String ipAddress) {
return ipAddress(Output.of(ipAddress));
}
/**
* @param ipProtocol The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in [Load balancing features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends).
*
* @return builder
*
*/
public Builder ipProtocol(@Nullable Output ipProtocol) {
$.ipProtocol = ipProtocol;
return this;
}
/**
* @param ipProtocol The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in [Load balancing features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends).
*
* @return builder
*
*/
public Builder ipProtocol(ForwardingRuleIpProtocol ipProtocol) {
return ipProtocol(Output.of(ipProtocol));
}
/**
* @param ipVersion The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6.
*
* @return builder
*
*/
public Builder ipVersion(@Nullable Output ipVersion) {
$.ipVersion = ipVersion;
return this;
}
/**
* @param ipVersion The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6.
*
* @return builder
*
*/
public Builder ipVersion(ForwardingRuleIpVersion ipVersion) {
return ipVersion(Output.of(ipVersion));
}
/**
* @param isMirroringCollector Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL.
*
* @return builder
*
*/
public Builder isMirroringCollector(@Nullable Output isMirroringCollector) {
$.isMirroringCollector = isMirroringCollector;
return this;
}
/**
* @param isMirroringCollector Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL.
*
* @return builder
*
*/
public Builder isMirroringCollector(Boolean isMirroringCollector) {
return isMirroringCollector(Output.of(isMirroringCollector));
}
/**
* @param labels Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
*
* @return builder
*
*/
public Builder labels(@Nullable Output> labels) {
$.labels = labels;
return this;
}
/**
* @param labels Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.
*
* @return builder
*
*/
public Builder labels(Map labels) {
return labels(Output.of(labels));
}
/**
* @param loadBalancingScheme Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts.
*
* @return builder
*
*/
public Builder loadBalancingScheme(@Nullable Output loadBalancingScheme) {
$.loadBalancingScheme = loadBalancingScheme;
return this;
}
/**
* @param loadBalancingScheme Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts.
*
* @return builder
*
*/
public Builder loadBalancingScheme(ForwardingRuleLoadBalancingScheme loadBalancingScheme) {
return loadBalancingScheme(Output.of(loadBalancingScheme));
}
/**
* @param metadataFilters Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not visible to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.
*
* @return builder
*
*/
public Builder metadataFilters(@Nullable Output> metadataFilters) {
$.metadataFilters = metadataFilters;
return this;
}
/**
* @param metadataFilters Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not visible to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.
*
* @return builder
*
*/
public Builder metadataFilters(List metadataFilters) {
return metadataFilters(Output.of(metadataFilters));
}
/**
* @param metadataFilters Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not visible to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.
*
* @return builder
*
*/
public Builder metadataFilters(MetadataFilterArgs... metadataFilters) {
return metadataFilters(List.of(metadataFilters));
}
/**
* @param name Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For Private Service Connect forwarding rules that forward traffic to Google APIs, the forwarding rule name must be a 1-20 characters string with lowercase letters and numbers and must start with a letter.
*
* @return builder
*
*/
public Builder name(@Nullable Output name) {
$.name = name;
return this;
}
/**
* @param name Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For Private Service Connect forwarding rules that forward traffic to Google APIs, the forwarding rule name must be a 1-20 characters string with lowercase letters and numbers and must start with a letter.
*
* @return builder
*
*/
public Builder name(String name) {
return name(Output.of(name));
}
/**
* @param network This field is not used for external load balancing. For Internal TCP/UDP Load Balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If the subnetwork is specified, the network of the subnetwork will be used. If neither subnetwork nor this field is specified, the default network will be used. For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided.
*
* @return builder
*
*/
public Builder network(@Nullable Output network) {
$.network = network;
return this;
}
/**
* @param network This field is not used for external load balancing. For Internal TCP/UDP Load Balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If the subnetwork is specified, the network of the subnetwork will be used. If neither subnetwork nor this field is specified, the default network will be used. For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided.
*
* @return builder
*
*/
public Builder network(String network) {
return network(Output.of(network));
}
/**
* @param networkTier This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address.
*
* @return builder
*
*/
public Builder networkTier(@Nullable Output networkTier) {
$.networkTier = networkTier;
return this;
}
/**
* @param networkTier This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address.
*
* @return builder
*
*/
public Builder networkTier(ForwardingRuleNetworkTier networkTier) {
return networkTier(Output.of(networkTier));
}
/**
* @param noAutomateDnsZone This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field.
*
* @return builder
*
*/
public Builder noAutomateDnsZone(@Nullable Output noAutomateDnsZone) {
$.noAutomateDnsZone = noAutomateDnsZone;
return this;
}
/**
* @param noAutomateDnsZone This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field.
*
* @return builder
*
*/
public Builder noAutomateDnsZone(Boolean noAutomateDnsZone) {
return noAutomateDnsZone(Output.of(noAutomateDnsZone));
}
/**
* @param portRange This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By backend service-based network load balancers, target pool-based network load balancers, internal proxy load balancers, external proxy load balancers, Traffic Director, external protocol forwarding, and Classic VPN. Some products have restrictions on what ports can be used. See port specifications for details. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \\d+(?:-\\d+)?
*
* @return builder
*
*/
public Builder portRange(@Nullable Output portRange) {
$.portRange = portRange;
return this;
}
/**
* @param portRange This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By backend service-based network load balancers, target pool-based network load balancers, internal proxy load balancers, external proxy load balancers, Traffic Director, external protocol forwarding, and Classic VPN. Some products have restrictions on what ports can be used. See port specifications for details. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \\d+(?:-\\d+)?
*
* @return builder
*
*/
public Builder portRange(String portRange) {
return portRange(Output.of(portRange));
}
/**
* @param ports This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal protocol forwarding. You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. The ports, port_range, and allPorts fields are mutually exclusive. @pattern: \\d+(?:-\\d+)?
*
* @return builder
*
*/
public Builder ports(@Nullable Output> ports) {
$.ports = ports;
return this;
}
/**
* @param ports This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal protocol forwarding. You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. The ports, port_range, and allPorts fields are mutually exclusive. @pattern: \\d+(?:-\\d+)?
*
* @return builder
*
*/
public Builder ports(List ports) {
return ports(Output.of(ports));
}
/**
* @param ports This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal protocol forwarding. You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. The ports, port_range, and allPorts fields are mutually exclusive. @pattern: \\d+(?:-\\d+)?
*
* @return builder
*
*/
public Builder ports(String... ports) {
return ports(List.of(ports));
}
public Builder project(@Nullable Output project) {
$.project = project;
return this;
}
public Builder project(String project) {
return project(Output.of(project));
}
public Builder pscConnectionStatus(@Nullable Output pscConnectionStatus) {
$.pscConnectionStatus = pscConnectionStatus;
return this;
}
public Builder pscConnectionStatus(ForwardingRulePscConnectionStatus pscConnectionStatus) {
return pscConnectionStatus(Output.of(pscConnectionStatus));
}
public Builder region(Output region) {
$.region = region;
return this;
}
public Builder region(String region) {
return region(Output.of(region));
}
/**
* @param requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
*
* @return builder
*
*/
public Builder requestId(@Nullable Output requestId) {
$.requestId = requestId;
return this;
}
/**
* @param requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
*
* @return builder
*
*/
public Builder requestId(String requestId) {
return requestId(Output.of(requestId));
}
/**
* @param serviceDirectoryRegistrations Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource.
*
* @return builder
*
*/
public Builder serviceDirectoryRegistrations(@Nullable Output> serviceDirectoryRegistrations) {
$.serviceDirectoryRegistrations = serviceDirectoryRegistrations;
return this;
}
/**
* @param serviceDirectoryRegistrations Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource.
*
* @return builder
*
*/
public Builder serviceDirectoryRegistrations(List serviceDirectoryRegistrations) {
return serviceDirectoryRegistrations(Output.of(serviceDirectoryRegistrations));
}
/**
* @param serviceDirectoryRegistrations Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource.
*
* @return builder
*
*/
public Builder serviceDirectoryRegistrations(ForwardingRuleServiceDirectoryRegistrationArgs... serviceDirectoryRegistrations) {
return serviceDirectoryRegistrations(List.of(serviceDirectoryRegistrations));
}
/**
* @param serviceLabel An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing.
*
* @return builder
*
*/
public Builder serviceLabel(@Nullable Output serviceLabel) {
$.serviceLabel = serviceLabel;
return this;
}
/**
* @param serviceLabel An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing.
*
* @return builder
*
*/
public Builder serviceLabel(String serviceLabel) {
return serviceLabel(Output.of(serviceLabel));
}
/**
* @param sourceIpRanges If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each source_ip_range entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).
*
* @return builder
*
*/
public Builder sourceIpRanges(@Nullable Output> sourceIpRanges) {
$.sourceIpRanges = sourceIpRanges;
return this;
}
/**
* @param sourceIpRanges If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each source_ip_range entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).
*
* @return builder
*
*/
public Builder sourceIpRanges(List sourceIpRanges) {
return sourceIpRanges(Output.of(sourceIpRanges));
}
/**
* @param sourceIpRanges If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each source_ip_range entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).
*
* @return builder
*
*/
public Builder sourceIpRanges(String... sourceIpRanges) {
return sourceIpRanges(List.of(sourceIpRanges));
}
/**
* @param subnetwork This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6.
*
* @return builder
*
*/
public Builder subnetwork(@Nullable Output subnetwork) {
$.subnetwork = subnetwork;
return this;
}
/**
* @param subnetwork This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6.
*
* @return builder
*
*/
public Builder subnetwork(String subnetwork) {
return subnetwork(Output.of(subnetwork));
}
/**
* @param target The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment.
*
* @return builder
*
*/
public Builder target(@Nullable Output target) {
$.target = target;
return this;
}
/**
* @param target The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment.
*
* @return builder
*
*/
public Builder target(String target) {
return target(Output.of(target));
}
public ForwardingRuleArgs build() {
$.region = Objects.requireNonNull($.region, "expected parameter 'region' to be non-null");
return $;
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy