Interface GatewayOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
Gateway,Gateway.Builder
@Generated
public interface GatewayOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionbooleancontainsLabels(String key) Optional.getAddresses(int index) Optional.com.google.protobuf.ByteStringgetAddressesBytes(int index) Optional.intOptional.Optional.getCertificateUrls(int index) Optional.com.google.protobuf.ByteStringgetCertificateUrlsBytes(int index) Optional.intOptional.Optional.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.Optional.com.google.protobuf.ByteStringOptional.Optional.intOptional.Optional.com.google.protobuf.ByteStringOptional.Optional.intOptional.Deprecated.intOptional.Optional.getLabelsOrDefault(String key, String defaultValue) Optional.getLabelsOrThrow(String key) Optional.getName()Identifier.com.google.protobuf.ByteStringIdentifier.Optional.com.google.protobuf.ByteStringOptional.intgetPorts(int index) Required.intRequired.Required.Optional.intOptional.getScope()Optional.com.google.protobuf.ByteStringOptional.Output only.com.google.protobuf.ByteStringOutput only.Optional.com.google.protobuf.ByteStringOptional.Optional.com.google.protobuf.ByteStringOptional.getType()Immutable.intImmutable.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.booleanOutput only.booleanOptional.booleanOutput only.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getName
String getName()Identifier. Name of the Gateway resource. It matches pattern `projects/*/locations/*/gateways/<gateway_name>`.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];- Returns:
- The name.
-
getNameBytes
com.google.protobuf.ByteString getNameBytes()Identifier. Name of the Gateway resource. It matches pattern `projects/*/locations/*/gateways/<gateway_name>`.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];- Returns:
- The bytes for name.
-
getSelfLink
String getSelfLink()Output only. Server-defined URL of this resource
string self_link = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The selfLink.
-
getSelfLinkBytes
com.google.protobuf.ByteString getSelfLinkBytes()Output only. Server-defined URL of this resource
string self_link = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The bytes for selfLink.
-
hasCreateTime
boolean hasCreateTime()Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the createTime field is set.
-
getCreateTime
com.google.protobuf.Timestamp getCreateTime()Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The createTime.
-
getCreateTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()Output only. The timestamp when the resource was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
hasUpdateTime
boolean hasUpdateTime()Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- Whether the updateTime field is set.
-
getUpdateTime
com.google.protobuf.Timestamp getUpdateTime()Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];- Returns:
- The updateTime.
-
getUpdateTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()Output only. The timestamp when the resource was updated.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY]; -
getLabelsCount
int getLabelsCount()Optional. Set of label tags associated with the Gateway resource.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL]; -
containsLabels
Optional. Set of label tags associated with the Gateway resource.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL]; -
getLabels
Deprecated.UsegetLabelsMap()instead. -
getLabelsMap
Optional. Set of label tags associated with the Gateway resource.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL]; -
getLabelsOrDefault
Optional. Set of label tags associated with the Gateway resource.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL]; -
getLabelsOrThrow
Optional. Set of label tags associated with the Gateway resource.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL]; -
getDescription
String getDescription()Optional. A free-text description of the resource. Max length 1024 characters.
string description = 5 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The description.
-
getDescriptionBytes
com.google.protobuf.ByteString getDescriptionBytes()Optional. A free-text description of the resource. Max length 1024 characters.
string description = 5 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The bytes for description.
-
getTypeValue
int getTypeValue()Immutable. The type of the customer managed gateway. This field is required. If unspecified, an error is returned.
.google.cloud.networkservices.v1.Gateway.Type type = 6 [(.google.api.field_behavior) = IMMUTABLE];- Returns:
- The enum numeric value on the wire for type.
-
getType
Gateway.Type getType()Immutable. The type of the customer managed gateway. This field is required. If unspecified, an error is returned.
.google.cloud.networkservices.v1.Gateway.Type type = 6 [(.google.api.field_behavior) = IMMUTABLE];- Returns:
- The type.
-
getAddressesList
Optional. Zero or one IPv4 or IPv6 address on which the Gateway will receive the traffic. When no address is provided, an IP from the subnetwork is allocated This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6.
repeated string addresses = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }- Returns:
- A list containing the addresses.
-
getAddressesCount
int getAddressesCount()Optional. Zero or one IPv4 or IPv6 address on which the Gateway will receive the traffic. When no address is provided, an IP from the subnetwork is allocated This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6.
repeated string addresses = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }- Returns:
- The count of addresses.
-
getAddresses
Optional. Zero or one IPv4 or IPv6 address on which the Gateway will receive the traffic. When no address is provided, an IP from the subnetwork is allocated This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6.
repeated string addresses = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }- Parameters:
index- The index of the element to return.- Returns:
- The addresses at the given index.
-
getAddressesBytes
com.google.protobuf.ByteString getAddressesBytes(int index) Optional. Zero or one IPv4 or IPv6 address on which the Gateway will receive the traffic. When no address is provided, an IP from the subnetwork is allocated This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6.
repeated string addresses = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the addresses at the given index.
-
getPortsList
Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports.
repeated int32 ports = 11 [(.google.api.field_behavior) = REQUIRED];- Returns:
- A list containing the ports.
-
getPortsCount
int getPortsCount()Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports.
repeated int32 ports = 11 [(.google.api.field_behavior) = REQUIRED];- Returns:
- The count of ports.
-
getPorts
int getPorts(int index) Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports.
repeated int32 ports = 11 [(.google.api.field_behavior) = REQUIRED];- Parameters:
index- The index of the element to return.- Returns:
- The ports at the given index.
-
getScope
String getScope()Optional. Scope determines how configuration across multiple Gateway instances are merged. The configuration for multiple Gateway instances with the same scope will be merged as presented as a single configuration to the proxy/load balancer. Max length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens.
string scope = 8 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The scope.
-
getScopeBytes
com.google.protobuf.ByteString getScopeBytes()Optional. Scope determines how configuration across multiple Gateway instances are merged. The configuration for multiple Gateway instances with the same scope will be merged as presented as a single configuration to the proxy/load balancer. Max length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens.
string scope = 8 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The bytes for scope.
-
getServerTlsPolicy
String getServerTlsPolicy()Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled.
string server_tls_policy = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }- Returns:
- The serverTlsPolicy.
-
getServerTlsPolicyBytes
com.google.protobuf.ByteString getServerTlsPolicyBytes()Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled.
string server_tls_policy = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }- Returns:
- The bytes for serverTlsPolicy.
-
getCertificateUrlsList
Optional. A fully-qualified Certificates URL reference. The proxy presents a Certificate (selected based on SNI) when establishing a TLS connection. This feature only applies to gateways of type 'SECURE_WEB_GATEWAY'.
repeated string certificate_urls = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }- Returns:
- A list containing the certificateUrls.
-
getCertificateUrlsCount
int getCertificateUrlsCount()Optional. A fully-qualified Certificates URL reference. The proxy presents a Certificate (selected based on SNI) when establishing a TLS connection. This feature only applies to gateways of type 'SECURE_WEB_GATEWAY'.
repeated string certificate_urls = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }- Returns:
- The count of certificateUrls.
-
getCertificateUrls
Optional. A fully-qualified Certificates URL reference. The proxy presents a Certificate (selected based on SNI) when establishing a TLS connection. This feature only applies to gateways of type 'SECURE_WEB_GATEWAY'.
repeated string certificate_urls = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }- Parameters:
index- The index of the element to return.- Returns:
- The certificateUrls at the given index.
-
getCertificateUrlsBytes
com.google.protobuf.ByteString getCertificateUrlsBytes(int index) Optional. A fully-qualified Certificates URL reference. The proxy presents a Certificate (selected based on SNI) when establishing a TLS connection. This feature only applies to gateways of type 'SECURE_WEB_GATEWAY'.
repeated string certificate_urls = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the certificateUrls at the given index.
-
getGatewaySecurityPolicy
String getGatewaySecurityPolicy()Optional. A fully-qualified GatewaySecurityPolicy URL reference. Defines how a server should apply security policy to inbound (VM to Proxy) initiated connections. For example: `projects/*/locations/*/gatewaySecurityPolicies/swg-policy`. This policy is specific to gateways of type 'SECURE_WEB_GATEWAY'.
string gateway_security_policy = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }- Returns:
- The gatewaySecurityPolicy.
-
getGatewaySecurityPolicyBytes
com.google.protobuf.ByteString getGatewaySecurityPolicyBytes()Optional. A fully-qualified GatewaySecurityPolicy URL reference. Defines how a server should apply security policy to inbound (VM to Proxy) initiated connections. For example: `projects/*/locations/*/gatewaySecurityPolicies/swg-policy`. This policy is specific to gateways of type 'SECURE_WEB_GATEWAY'.
string gateway_security_policy = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }- Returns:
- The bytes for gatewaySecurityPolicy.
-
getNetwork
String getNetwork()Optional. The relative resource name identifying the VPC network that is using this configuration. For example: `projects/*/global/networks/network-1`. Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY'.
string network = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }- Returns:
- The network.
-
getNetworkBytes
com.google.protobuf.ByteString getNetworkBytes()Optional. The relative resource name identifying the VPC network that is using this configuration. For example: `projects/*/global/networks/network-1`. Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY'.
string network = 16 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }- Returns:
- The bytes for network.
-
getSubnetwork
String getSubnetwork()Optional. The relative resource name identifying the subnetwork in which this SWG is allocated. For example: `projects/*/regions/us-central1/subnetworks/network-1` Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY".
string subnetwork = 17 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }- Returns:
- The subnetwork.
-
getSubnetworkBytes
com.google.protobuf.ByteString getSubnetworkBytes()Optional. The relative resource name identifying the subnetwork in which this SWG is allocated. For example: `projects/*/regions/us-central1/subnetworks/network-1` Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY".
string subnetwork = 17 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }- Returns:
- The bytes for subnetwork.
-
getIpVersionValue
int getIpVersionValue()Optional. The IP Version that will be used by this gateway. Valid options are IPV4 or IPV6. Default is IPV4.
.google.cloud.networkservices.v1.Gateway.IpVersion ip_version = 21 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The enum numeric value on the wire for ipVersion.
-
getIpVersion
Gateway.IpVersion getIpVersion()Optional. The IP Version that will be used by this gateway. Valid options are IPV4 or IPV6. Default is IPV4.
.google.cloud.networkservices.v1.Gateway.IpVersion ip_version = 21 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The ipVersion.
-
hasEnvoyHeaders
boolean hasEnvoyHeaders()Optional. Determines if envoy will insert internal debug headers into upstream requests. Other Envoy headers may still be injected. By default, envoy will not insert any debug headers.
optional .google.cloud.networkservices.v1.EnvoyHeaders envoy_headers = 28 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- Whether the envoyHeaders field is set.
-
getEnvoyHeadersValue
int getEnvoyHeadersValue()Optional. Determines if envoy will insert internal debug headers into upstream requests. Other Envoy headers may still be injected. By default, envoy will not insert any debug headers.
optional .google.cloud.networkservices.v1.EnvoyHeaders envoy_headers = 28 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The enum numeric value on the wire for envoyHeaders.
-
getEnvoyHeaders
EnvoyHeaders getEnvoyHeaders()Optional. Determines if envoy will insert internal debug headers into upstream requests. Other Envoy headers may still be injected. By default, envoy will not insert any debug headers.
optional .google.cloud.networkservices.v1.EnvoyHeaders envoy_headers = 28 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The envoyHeaders.
-
getRoutingModeValue
int getRoutingModeValue()Optional. The routing mode of the Gateway. This field is configurable only for gateways of type SECURE_WEB_GATEWAY. This field is required for gateways of type SECURE_WEB_GATEWAY.
.google.cloud.networkservices.v1.Gateway.RoutingMode routing_mode = 32 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The enum numeric value on the wire for routingMode.
-
getRoutingMode
Gateway.RoutingMode getRoutingMode()Optional. The routing mode of the Gateway. This field is configurable only for gateways of type SECURE_WEB_GATEWAY. This field is required for gateways of type SECURE_WEB_GATEWAY.
.google.cloud.networkservices.v1.Gateway.RoutingMode routing_mode = 32 [(.google.api.field_behavior) = OPTIONAL];- Returns:
- The routingMode.
-