Class TransitionAttributes (1.29.0)

public final class TransitionAttributes extends GeneratedMessageV3 implements TransitionAttributesOrBuilder

Specifies attributes of transitions between two consecutive visits on a route. Several TransitionAttributes may apply to the same transition: in that case, all extra costs add up and the strictest constraint or limit applies (following natural "AND" semantics).

Protobuf type google.cloud.optimization.v1.TransitionAttributes

Static Fields

COST_FIELD_NUMBER

public static final int COST_FIELD_NUMBER
Field Value
TypeDescription
int

COST_PER_KILOMETER_FIELD_NUMBER

public static final int COST_PER_KILOMETER_FIELD_NUMBER
Field Value
TypeDescription
int

DELAY_FIELD_NUMBER

public static final int DELAY_FIELD_NUMBER
Field Value
TypeDescription
int

DISTANCE_LIMIT_FIELD_NUMBER

public static final int DISTANCE_LIMIT_FIELD_NUMBER
Field Value
TypeDescription
int

DST_TAG_FIELD_NUMBER

public static final int DST_TAG_FIELD_NUMBER
Field Value
TypeDescription
int

EXCLUDED_DST_TAG_FIELD_NUMBER

public static final int EXCLUDED_DST_TAG_FIELD_NUMBER
Field Value
TypeDescription
int

EXCLUDED_SRC_TAG_FIELD_NUMBER

public static final int EXCLUDED_SRC_TAG_FIELD_NUMBER
Field Value
TypeDescription
int

SRC_TAG_FIELD_NUMBER

public static final int SRC_TAG_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static TransitionAttributes getDefaultInstance()
Returns
TypeDescription
TransitionAttributes

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static TransitionAttributes.Builder newBuilder()
Returns
TypeDescription
TransitionAttributes.Builder

newBuilder(TransitionAttributes prototype)

public static TransitionAttributes.Builder newBuilder(TransitionAttributes prototype)
Parameter
NameDescription
prototypeTransitionAttributes
Returns
TypeDescription
TransitionAttributes.Builder

parseDelimitedFrom(InputStream input)

public static TransitionAttributes parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TransitionAttributes
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransitionAttributes parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransitionAttributes
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static TransitionAttributes parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
TransitionAttributes
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TransitionAttributes parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransitionAttributes
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TransitionAttributes parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
TransitionAttributes
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TransitionAttributes parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransitionAttributes
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TransitionAttributes parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
TransitionAttributes
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TransitionAttributes parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransitionAttributes
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static TransitionAttributes parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TransitionAttributes
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransitionAttributes parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransitionAttributes
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static TransitionAttributes parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
TransitionAttributes
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TransitionAttributes parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransitionAttributes
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<TransitionAttributes> parser()
Returns
TypeDescription
Parser<TransitionAttributes>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCost()

public double getCost()

Specifies a cost for performing this transition. This is in the same unit as all other costs in the model and must not be negative. It is applied on top of all other existing costs.

double cost = 5;

Returns
TypeDescription
double

The cost.

getCostPerKilometer()

public double getCostPerKilometer()

Specifies a cost per kilometer applied to the distance traveled while performing this transition. It adds up to any Vehicle.cost_per_kilometer specified on vehicles.

double cost_per_kilometer = 6;

Returns
TypeDescription
double

The costPerKilometer.

getDefaultInstanceForType()

public TransitionAttributes getDefaultInstanceForType()
Returns
TypeDescription
TransitionAttributes

getDelay()

public Duration getDelay()

Specifies a delay incurred when performing this transition.

This delay always occurs after finishing the source visit and before starting the destination visit.

.google.protobuf.Duration delay = 8;

Returns
TypeDescription
Duration

The delay.

getDelayOrBuilder()

public DurationOrBuilder getDelayOrBuilder()

Specifies a delay incurred when performing this transition.

This delay always occurs after finishing the source visit and before starting the destination visit.

.google.protobuf.Duration delay = 8;

Returns
TypeDescription
DurationOrBuilder

getDistanceLimit()

public DistanceLimit getDistanceLimit()

Specifies a limit on the distance traveled while performing this transition.

As of 2021/06, only soft limits are supported.

.google.cloud.optimization.v1.DistanceLimit distance_limit = 7;

Returns
TypeDescription
DistanceLimit

The distanceLimit.

getDistanceLimitOrBuilder()

public DistanceLimitOrBuilder getDistanceLimitOrBuilder()

Specifies a limit on the distance traveled while performing this transition.

As of 2021/06, only soft limits are supported.

.google.cloud.optimization.v1.DistanceLimit distance_limit = 7;

Returns
TypeDescription
DistanceLimitOrBuilder

getDstTag()

public String getDstTag()

A destination visit or vehicle end matches iff its VisitRequest.tags or Vehicle.end_tags either contains dst_tag or does not contain excluded_dst_tag (depending on which of these two fields is non-empty).

string dst_tag = 3;

Returns
TypeDescription
String

The dstTag.

getDstTagBytes()

public ByteString getDstTagBytes()

A destination visit or vehicle end matches iff its VisitRequest.tags or Vehicle.end_tags either contains dst_tag or does not contain excluded_dst_tag (depending on which of these two fields is non-empty).

string dst_tag = 3;

Returns
TypeDescription
ByteString

The bytes for dstTag.

getExcludedDstTag()

public String getExcludedDstTag()

See dst_tag. Exactly one of dst_tag and excluded_dst_tag must be non-empty.

string excluded_dst_tag = 4;

Returns
TypeDescription
String

The excludedDstTag.

getExcludedDstTagBytes()

public ByteString getExcludedDstTagBytes()

See dst_tag. Exactly one of dst_tag and excluded_dst_tag must be non-empty.

string excluded_dst_tag = 4;

Returns
TypeDescription
ByteString

The bytes for excludedDstTag.

getExcludedSrcTag()

public String getExcludedSrcTag()

See src_tag. Exactly one of src_tag and excluded_src_tag must be non-empty.

string excluded_src_tag = 2;

Returns
TypeDescription
String

The excludedSrcTag.

getExcludedSrcTagBytes()

public ByteString getExcludedSrcTagBytes()

See src_tag. Exactly one of src_tag and excluded_src_tag must be non-empty.

string excluded_src_tag = 2;

Returns
TypeDescription
ByteString

The bytes for excludedSrcTag.

getParserForType()

public Parser<TransitionAttributes> getParserForType()
Returns
TypeDescription
Parser<TransitionAttributes>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSrcTag()

public String getSrcTag()

Tags defining the set of (src->dst) transitions these attributes apply to.

A source visit or vehicle start matches iff its VisitRequest.tags or Vehicle.start_tags either contains src_tag or does not contain excluded_src_tag (depending on which of these two fields is non-empty).

string src_tag = 1;

Returns
TypeDescription
String

The srcTag.

getSrcTagBytes()

public ByteString getSrcTagBytes()

Tags defining the set of (src->dst) transitions these attributes apply to.

A source visit or vehicle start matches iff its VisitRequest.tags or Vehicle.start_tags either contains src_tag or does not contain excluded_src_tag (depending on which of these two fields is non-empty).

string src_tag = 1;

Returns
TypeDescription
ByteString

The bytes for srcTag.

hasDelay()

public boolean hasDelay()

Specifies a delay incurred when performing this transition.

This delay always occurs after finishing the source visit and before starting the destination visit.

.google.protobuf.Duration delay = 8;

Returns
TypeDescription
boolean

Whether the delay field is set.

hasDistanceLimit()

public boolean hasDistanceLimit()

Specifies a limit on the distance traveled while performing this transition.

As of 2021/06, only soft limits are supported.

.google.cloud.optimization.v1.DistanceLimit distance_limit = 7;

Returns
TypeDescription
boolean

Whether the distanceLimit field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public TransitionAttributes.Builder newBuilderForType()
Returns
TypeDescription
TransitionAttributes.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TransitionAttributes.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
TransitionAttributes.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public TransitionAttributes.Builder toBuilder()
Returns
TypeDescription
TransitionAttributes.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException