Class Gateway (0.15.0) 

public final class Gateway extends GeneratedMessageV3 implements GatewayOrBuilder

Gateway represents the configuration for a proxy, typically a load balancer. It captures the ip:port over which the services are exposed by the proxy, along with any policy configurations. Routes have reference to to Gateways to dictate how requests should be routed by this Gateway.

Protobuf type google.events.cloud.networkservices.v1.Gateway

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Gateway

Implements

GatewayOrBuilder

Static Fields

ADDRESSES_FIELD_NUMBER

public static final int ADDRESSES_FIELD_NUMBER
Field Value
Type Description
int

CERTIFICATE_URLS_FIELD_NUMBER

public static final int CERTIFICATE_URLS_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

GATEWAY_SECURITY_POLICY_FIELD_NUMBER

public static final int GATEWAY_SECURITY_POLICY_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

NETWORK_FIELD_NUMBER

public static final int NETWORK_FIELD_NUMBER
Field Value
Type Description
int

PORTS_FIELD_NUMBER

public static final int PORTS_FIELD_NUMBER
Field Value
Type Description
int

SCOPE_FIELD_NUMBER

public static final int SCOPE_FIELD_NUMBER
Field Value
Type Description
int 
public static final int SELF_LINK_FIELD_NUMBER
Field Value
Type Description
int

SERVER_TLS_POLICY_FIELD_NUMBER

public static final int SERVER_TLS_POLICY_FIELD_NUMBER
Field Value
Type Description
int

SUBNETWORK_FIELD_NUMBER

public static final int SUBNETWORK_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Gateway getDefaultInstance()
Returns
Type Description
Gateway

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Gateway.Builder newBuilder()
Returns
Type Description
Gateway.Builder

newBuilder(Gateway prototype)

public static Gateway.Builder newBuilder(Gateway prototype)
Parameter
Name Description
prototype Gateway
Returns
Type Description
Gateway.Builder

parseDelimitedFrom(InputStream input)

public static Gateway parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Gateway
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Gateway parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Gateway
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Gateway parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Gateway
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Gateway parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Gateway
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Gateway parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Gateway
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Gateway parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Gateway
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Gateway parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Gateway
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Gateway parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Gateway
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Gateway parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Gateway
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Gateway parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Gateway
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Gateway parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Gateway
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Gateway parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Gateway
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Gateway> parser()
Returns
Type Description
Parser<Gateway>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Optional. Set of label tags associated with the Gateway resource.

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAddresses(int index)

public String getAddresses(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;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The addresses at the given index.

getAddressesBytes(int index)

public 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;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the addresses at the given index.

getAddressesCount()

public 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;

Returns
Type Description
int

The count of addresses.

getAddressesList()

public ProtocolStringList 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;

Returns
Type Description
ProtocolStringList

A list containing the addresses.

getCertificateUrls(int index)

public String getCertificateUrls(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;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The certificateUrls at the given index.

getCertificateUrlsBytes(int index)

public 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;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the certificateUrls at the given index.

getCertificateUrlsCount()

public 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;

Returns
Type Description
int

The count of certificateUrls.

getCertificateUrlsList()

public ProtocolStringList 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;

Returns
Type Description
ProtocolStringList

A list containing the certificateUrls.

getCreateTime()

public Timestamp getCreateTime()

Output only. The timestamp when the resource was created.

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The timestamp when the resource was created.

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Gateway getDefaultInstanceForType()
Returns
Type Description
Gateway

getDescription()

public String getDescription()

Optional. A free-text description of the resource. Max length 1024 characters.

string description = 5;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. A free-text description of the resource. Max length 1024 characters.

string description = 5;

Returns
Type Description
ByteString

The bytes for description.

getGatewaySecurityPolicy()

public 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;

Returns
Type Description
String

The gatewaySecurityPolicy.

getGatewaySecurityPolicyBytes()

public 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;

Returns
Type Description
ByteString

The bytes for gatewaySecurityPolicy.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Set of label tags associated with the Gateway resource.

map<string, string> labels = 4;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. Set of label tags associated with the Gateway resource.

map<string, string> labels = 4;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. Set of label tags associated with the Gateway resource.

map<string, string> labels = 4;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. Set of label tags associated with the Gateway resource.

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public String getName()

Required. Name of the Gateway resource. It matches pattern projects/*/locations/*/gateways/<gateway_name>.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. Name of the Gateway resource. It matches pattern projects/*/locations/*/gateways/<gateway_name>.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getNetwork()

public 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;

Returns
Type Description
String

The network.

getNetworkBytes()

public 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;

Returns
Type Description
ByteString

The bytes for network.

getParserForType()

public Parser<Gateway> getParserForType()
Returns
Type Description
Parser<Gateway>
Overrides

getPorts(int index)

public 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;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
int

The ports at the given index.

getPortsCount()

public 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;

Returns
Type Description
int

The count of ports.

getPortsList()

public List<Integer> 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;

Returns
Type Description
List<Integer>

A list containing the ports.

getScope()

public 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 coniguration 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;

Returns
Type Description
String

The scope.

getScopeBytes()

public 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 coniguration 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;

Returns
Type Description
ByteString

The bytes for scope.

getSelfLink()

public String getSelfLink()

Output only. Server-defined URL of this resource

string self_link = 13;

Returns
Type Description
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

Output only. Server-defined URL of this resource

string self_link = 13;

Returns
Type Description
ByteString

The bytes for selfLink.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServerTlsPolicy()

public 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;

Returns
Type Description
String

The serverTlsPolicy.

getServerTlsPolicyBytes()

public 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;

Returns
Type Description
ByteString

The bytes for serverTlsPolicy.

getSubnetwork()

public 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;

Returns
Type Description
String

The subnetwork.

getSubnetworkBytes()

public 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;

Returns
Type Description
ByteString

The bytes for subnetwork.

getType()

public Gateway.Type getType()

Immutable. The type of the customer managed gateway. This field is required. If unspecified, an error is returned.

.google.events.cloud.networkservices.v1.Gateway.Type type = 6;

Returns
Type Description
Gateway.Type

The type.

getTypeValue()

public int getTypeValue()

Immutable. The type of the customer managed gateway. This field is required. If unspecified, an error is returned.

.google.events.cloud.networkservices.v1.Gateway.Type type = 6;

Returns
Type Description
int

The enum numeric value on the wire for type.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The timestamp when the resource was updated.

.google.protobuf.Timestamp update_time = 3;

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The timestamp when the resource was updated.

.google.protobuf.Timestamp update_time = 3;

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The timestamp when the resource was created.

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The timestamp when the resource was updated.

.google.protobuf.Timestamp update_time = 3;

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Gateway.Builder newBuilderForType()
Returns
Type Description
Gateway.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Gateway.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Gateway.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Gateway.Builder toBuilder()
Returns
Type Description
Gateway.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException