Class AppGateway (0.41.0)

public final class AppGateway extends GeneratedMessageV3 implements AppGatewayOrBuilder

A BeyondCorp AppGateway resource represents a BeyondCorp protected AppGateway to a remote application. It creates all the necessary GCP components needed for creating a BeyondCorp protected AppGateway. Multiple connectors can be authorised for a single AppGateway.

Protobuf type google.cloud.beyondcorp.appgateways.v1.AppGateway

Implements

AppGatewayOrBuilder

Static Fields

ALLOCATED_CONNECTIONS_FIELD_NUMBER

public static final int ALLOCATED_CONNECTIONS_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

HOST_TYPE_FIELD_NUMBER

public static final int HOST_TYPE_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

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

UID_FIELD_NUMBER

public static final int UID_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

URI_FIELD_NUMBER

public static final int URI_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AppGateway getDefaultInstance()
Returns
Type Description
AppGateway

getDescriptor()

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

newBuilder()

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

newBuilder(AppGateway prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Optional. Resource labels to represent user provided metadata.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

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

getAllocatedConnections(int index)

public AppGateway.AllocatedConnection getAllocatedConnections(int index)

Output only. A list of connections allocated for the Gateway

repeated .google.cloud.beyondcorp.appgateways.v1.AppGateway.AllocatedConnection allocated_connections = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
AppGateway.AllocatedConnection

getAllocatedConnectionsCount()

public int getAllocatedConnectionsCount()

Output only. A list of connections allocated for the Gateway

repeated .google.cloud.beyondcorp.appgateways.v1.AppGateway.AllocatedConnection allocated_connections = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getAllocatedConnectionsList()

public List<AppGateway.AllocatedConnection> getAllocatedConnectionsList()

Output only. A list of connections allocated for the Gateway

repeated .google.cloud.beyondcorp.appgateways.v1.AppGateway.AllocatedConnection allocated_connections = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<AllocatedConnection>

getAllocatedConnectionsOrBuilder(int index)

public AppGateway.AllocatedConnectionOrBuilder getAllocatedConnectionsOrBuilder(int index)

Output only. A list of connections allocated for the Gateway

repeated .google.cloud.beyondcorp.appgateways.v1.AppGateway.AllocatedConnection allocated_connections = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
AppGateway.AllocatedConnectionOrBuilder

getAllocatedConnectionsOrBuilderList()

public List<? extends AppGateway.AllocatedConnectionOrBuilder> getAllocatedConnectionsOrBuilderList()

Output only. A list of connections allocated for the Gateway

repeated .google.cloud.beyondcorp.appgateways.v1.AppGateway.AllocatedConnection allocated_connections = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.beyondcorp.appgateways.v1.AppGateway.AllocatedConnectionOrBuilder>

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when the resource was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when the resource was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public AppGateway getDefaultInstanceForType()
Returns
Type Description
AppGateway

getDisplayName()

public String getDisplayName()

Optional. An arbitrary user-provided name for the AppGateway. Cannot exceed 64 characters.

string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. An arbitrary user-provided name for the AppGateway. Cannot exceed 64 characters.

string display_name = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

getHostType()

public AppGateway.HostType getHostType()

Required. The type of hosting used by the AppGateway.

.google.cloud.beyondcorp.appgateways.v1.AppGateway.HostType host_type = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AppGateway.HostType

The hostType.

getHostTypeValue()

public int getHostTypeValue()

Required. The type of hosting used by the AppGateway.

.google.cloud.beyondcorp.appgateways.v1.AppGateway.HostType host_type = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for hostType.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Resource labels to represent user provided metadata.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. Resource labels to represent user provided metadata.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. Resource labels to represent user provided metadata.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. Resource labels to represent user provided metadata.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public String getName()

Required. Unique resource name of the AppGateway. The name is ignored when creating an AppGateway.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. Unique resource name of the AppGateway. The name is ignored when creating an AppGateway.

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public AppGateway.State getState()

Output only. The current state of the AppGateway.

.google.cloud.beyondcorp.appgateways.v1.AppGateway.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AppGateway.State

The state.

getStateValue()

public int getStateValue()

Output only. The current state of the AppGateway.

.google.cloud.beyondcorp.appgateways.v1.AppGateway.State state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getType()

public AppGateway.Type getType()

Required. The type of network connectivity used by the AppGateway.

.google.cloud.beyondcorp.appgateways.v1.AppGateway.Type type = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AppGateway.Type

The type.

getTypeValue()

public int getTypeValue()

Required. The type of network connectivity used by the AppGateway.

.google.cloud.beyondcorp.appgateways.v1.AppGateway.Type type = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for type.

getUid()

public String getUid()

Output only. A unique identifier for the instance generated by the system.

string uid = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. A unique identifier for the instance generated by the system.

string uid = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for uid.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Timestamp when the resource was last modified.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when the resource was last modified.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getUri()

public String getUri()

Output only. Server-defined URI for this resource.

string uri = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The uri.

getUriBytes()

public ByteString getUriBytes()

Output only. Server-defined URI for this resource.

string uri = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for uri.

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when the resource was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Timestamp when the resource was last modified.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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