Class Transport (1.87.0)

public final class Transport extends GeneratedMessage implements TransportOrBuilder

Message describing Transport object.

Protobuf type google.cloud.networkconnectivity.v1beta.Transport

Implements

TransportOrBuilder

Static Fields

ADMIN_ENABLED_FIELD_NUMBER

public static final int ADMIN_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

ADVERTISED_ROUTES_FIELD_NUMBER

public static final int ADVERTISED_ROUTES_FIELD_NUMBER
Field Value
Type Description
int

BANDWIDTH_FIELD_NUMBER

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

GENERATED_ACTIVATION_KEY_FIELD_NUMBER

public static final int GENERATED_ACTIVATION_KEY_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

MTU_LIMIT_FIELD_NUMBER

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

PEERING_NETWORK_FIELD_NUMBER

public static final int PEERING_NETWORK_FIELD_NUMBER
Field Value
Type Description
int

PROVIDED_ACTIVATION_KEY_FIELD_NUMBER

public static final int PROVIDED_ACTIVATION_KEY_FIELD_NUMBER
Field Value
Type Description
int

REMOTE_ACCOUNT_ID_FIELD_NUMBER

public static final int REMOTE_ACCOUNT_ID_FIELD_NUMBER
Field Value
Type Description
int

REMOTE_PROFILE_FIELD_NUMBER

public static final int REMOTE_PROFILE_FIELD_NUMBER
Field Value
Type Description
int

STACK_TYPE_FIELD_NUMBER

public static final int STACK_TYPE_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_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 Transport getDefaultInstance()
Returns
Type Description
Transport

getDescriptor()

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

newBuilder()

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

newBuilder(Transport prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Optional. Labels as key value pairs.

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

getAdminEnabled()

public boolean getAdminEnabled()

Optional. Administrative state of the underlying connectivity. If set to true (default), connectivity should be available between your environments. If set to false, the connectivity over these links is disabled. Disabling your Transport does not affect billing, and retains the underlying network bandwidth associated with the connectivity.

bool admin_enabled = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The adminEnabled.

getAdvertisedRoutes(int index)

public String getAdvertisedRoutes(int index)

Optional. List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported.

repeated string advertised_routes = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The advertisedRoutes at the given index.

getAdvertisedRoutesBytes(int index)

public ByteString getAdvertisedRoutesBytes(int index)

Optional. List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported.

repeated string advertised_routes = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the advertisedRoutes at the given index.

getAdvertisedRoutesCount()

public int getAdvertisedRoutesCount()

Optional. List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported.

repeated string advertised_routes = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of advertisedRoutes.

getAdvertisedRoutesList()

public ProtocolStringList getAdvertisedRoutesList()

Optional. List of IP Prefixes that will be advertised to the remote provider. Both IPv4 and IPv6 addresses are supported.

repeated string advertised_routes = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the advertisedRoutes.

getBandwidth()

public Transport.Bandwidth getBandwidth()

Optional. Bandwidth of the Transport. This must be one of the supported bandwidths for the remote profile, and must be set when no activation key is being provided.

.google.cloud.networkconnectivity.v1beta.Transport.Bandwidth bandwidth = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Transport.Bandwidth

The bandwidth.

getBandwidthValue()

public int getBandwidthValue()

Optional. Bandwidth of the Transport. This must be one of the supported bandwidths for the remote profile, and must be set when no activation key is being provided.

.google.cloud.networkconnectivity.v1beta.Transport.Bandwidth bandwidth = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for bandwidth.

getCreateTime()

public Timestamp getCreateTime()

Output only. Create time stamp.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Create time stamp.

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Transport getDefaultInstanceForType()
Returns
Type Description
Transport

getDescription()

public String getDescription()

Optional. Description of the Transport.

string description = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Description of the Transport.

string description = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getGeneratedActivationKey()

public String getGeneratedActivationKey()

Output only. Google-generated activation key. This is only output if the selected profile supports an OUTPUT key flow. Inputting this to the provider is only valid while the resource is in a PENDING_KEY state. Once the provider has accepted the key, the resource will move to the CONFIGURING state.

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

Returns
Type Description
String

The generatedActivationKey.

getGeneratedActivationKeyBytes()

public ByteString getGeneratedActivationKeyBytes()

Output only. Google-generated activation key. This is only output if the selected profile supports an OUTPUT key flow. Inputting this to the provider is only valid while the resource is in a PENDING_KEY state. Once the provider has accepted the key, the resource will move to the CONFIGURING state.

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

Returns
Type Description
ByteString

The bytes for generatedActivationKey.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Labels as key value pairs.

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

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. Labels as key value pairs.

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. Labels as key value pairs.

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. Labels as key value pairs.

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

Parameter
Name Description
key String
Returns
Type Description
String

getMtuLimit()

public int getMtuLimit()

Output only. The maximum transmission unit (MTU) of a packet that can be sent over this transport.

int32 mtu_limit = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The mtuLimit.

getName()

public String getName()

Identifier. Name of the resource.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. Name of the resource.

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

Returns
Type Description
ByteString

The bytes for name.

getNetwork()

public String getNetwork()

Optional. Resource URI of the Network that will be peered with this Transport. This field must be provided during resource creation and cannot be changed.

string network = 15 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The network.

getNetworkBytes()

public ByteString getNetworkBytes()

Optional. Resource URI of the Network that will be peered with this Transport. This field must be provided during resource creation and cannot be changed.

string network = 15 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for network.

getParserForType()

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

getPeeringNetwork()

public String getPeeringNetwork()

Output only. VPC Network URI that was created for the VPC Peering connection to the provided network. If VPC Peering is disconnected, this can be used to re-establish.

string peering_network = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The peeringNetwork.

getPeeringNetworkBytes()

public ByteString getPeeringNetworkBytes()

Output only. VPC Network URI that was created for the VPC Peering connection to the provided network. If VPC Peering is disconnected, this can be used to re-establish.

string peering_network = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for peeringNetwork.

getProvidedActivationKey()

public String getProvidedActivationKey()

Optional. Key used for establishing a connection with the remote transport. This key can only be provided if the profile supports an INPUT key flow and the resource is in the PENDING_KEY state.

string provided_activation_key = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The providedActivationKey.

getProvidedActivationKeyBytes()

public ByteString getProvidedActivationKeyBytes()

Optional. Key used for establishing a connection with the remote transport. This key can only be provided if the profile supports an INPUT key flow and the resource is in the PENDING_KEY state.

string provided_activation_key = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for providedActivationKey.

getRemoteAccountId()

public String getRemoteAccountId()

Optional. The user supplied account id for the CSP associated with the remote profile.

string remote_account_id = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The remoteAccountId.

getRemoteAccountIdBytes()

public ByteString getRemoteAccountIdBytes()

Optional. The user supplied account id for the CSP associated with the remote profile.

string remote_account_id = 17 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for remoteAccountId.

getRemoteProfile()

public String getRemoteProfile()

Optional. Name of the remoteTransportProfile that this Transport is connecting to.

string remote_profile = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The remoteProfile.

getRemoteProfileBytes()

public ByteString getRemoteProfileBytes()

Optional. Name of the remoteTransportProfile that this Transport is connecting to.

string remote_profile = 7 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for remoteProfile.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStackType()

public Transport.StackType getStackType()

Optional. IP version stack for the established connectivity.

.google.cloud.networkconnectivity.v1beta.Transport.StackType stack_type = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Transport.StackType

The stackType.

getStackTypeValue()

public int getStackTypeValue()

Optional. IP version stack for the established connectivity.

.google.cloud.networkconnectivity.v1beta.Transport.StackType stack_type = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for stackType.

getState()

public Transport.State getState()

Output only. State of the underlying connectivity.

.google.cloud.networkconnectivity.v1beta.Transport.State state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Transport.State

The state.

getStateValue()

public int getStateValue()

Output only. State of the underlying connectivity.

.google.cloud.networkconnectivity.v1beta.Transport.State state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Update time stamp.

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Update time stamp.

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

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Create time stamp.

.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. Update time stamp.

.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 GeneratedMessage.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.GeneratedMessage.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Transport.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Transport.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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