Class GrpcRoute.StatefulSessionAffinityPolicy.Builder (0.23.0)

public static final class GrpcRoute.StatefulSessionAffinityPolicy.Builder extends GeneratedMessageV3.Builder<GrpcRoute.StatefulSessionAffinityPolicy.Builder> implements GrpcRoute.StatefulSessionAffinityPolicyOrBuilder

The specification for cookie-based stateful session affinity where the date plane supplies a “session cookie” with the name "GSSA" which encodes a specific destination host and each request containing that cookie will be directed to that host as long as the destination host remains up and healthy.

The gRPC proxyless mesh library or sidecar proxy will manage the session cookie but the client application code is responsible for copying the cookie from each RPC in the session to the next.

Protobuf type google.cloud.networkservices.v1.GrpcRoute.StatefulSessionAffinityPolicy

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public GrpcRoute.StatefulSessionAffinityPolicy.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GrpcRoute.StatefulSessionAffinityPolicy.Builder
Overrides

build()

public GrpcRoute.StatefulSessionAffinityPolicy build()
Returns
Type Description
GrpcRoute.StatefulSessionAffinityPolicy

buildPartial()

public GrpcRoute.StatefulSessionAffinityPolicy buildPartial()
Returns
Type Description
GrpcRoute.StatefulSessionAffinityPolicy

clear()

public GrpcRoute.StatefulSessionAffinityPolicy.Builder clear()
Returns
Type Description
GrpcRoute.StatefulSessionAffinityPolicy.Builder
Overrides

clearCookieTtl()

public GrpcRoute.StatefulSessionAffinityPolicy.Builder clearCookieTtl()

Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 0 to 86400 seconds (24 hours) inclusive.

Set this to 0s to use a session cookie and disable cookie expiration.

.google.protobuf.Duration cookie_ttl = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
GrpcRoute.StatefulSessionAffinityPolicy.Builder

clearField(Descriptors.FieldDescriptor field)

public GrpcRoute.StatefulSessionAffinityPolicy.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
GrpcRoute.StatefulSessionAffinityPolicy.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public GrpcRoute.StatefulSessionAffinityPolicy.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
GrpcRoute.StatefulSessionAffinityPolicy.Builder
Overrides

clone()

public GrpcRoute.StatefulSessionAffinityPolicy.Builder clone()
Returns
Type Description
GrpcRoute.StatefulSessionAffinityPolicy.Builder
Overrides

getCookieTtl()

public Duration getCookieTtl()

Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 0 to 86400 seconds (24 hours) inclusive.

Set this to 0s to use a session cookie and disable cookie expiration.

.google.protobuf.Duration cookie_ttl = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Duration

The cookieTtl.

getCookieTtlBuilder()

public Duration.Builder getCookieTtlBuilder()

Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 0 to 86400 seconds (24 hours) inclusive.

Set this to 0s to use a session cookie and disable cookie expiration.

.google.protobuf.Duration cookie_ttl = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Builder

getCookieTtlOrBuilder()

public DurationOrBuilder getCookieTtlOrBuilder()

Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 0 to 86400 seconds (24 hours) inclusive.

Set this to 0s to use a session cookie and disable cookie expiration.

.google.protobuf.Duration cookie_ttl = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DurationOrBuilder

getDefaultInstanceForType()

public GrpcRoute.StatefulSessionAffinityPolicy getDefaultInstanceForType()
Returns
Type Description
GrpcRoute.StatefulSessionAffinityPolicy

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

hasCookieTtl()

public boolean hasCookieTtl()

Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 0 to 86400 seconds (24 hours) inclusive.

Set this to 0s to use a session cookie and disable cookie expiration.

.google.protobuf.Duration cookie_ttl = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the cookieTtl field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCookieTtl(Duration value)

public GrpcRoute.StatefulSessionAffinityPolicy.Builder mergeCookieTtl(Duration value)

Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 0 to 86400 seconds (24 hours) inclusive.

Set this to 0s to use a session cookie and disable cookie expiration.

.google.protobuf.Duration cookie_ttl = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Duration
Returns
Type Description
GrpcRoute.StatefulSessionAffinityPolicy.Builder

mergeFrom(GrpcRoute.StatefulSessionAffinityPolicy other)

public GrpcRoute.StatefulSessionAffinityPolicy.Builder mergeFrom(GrpcRoute.StatefulSessionAffinityPolicy other)
Parameter
Name Description
other GrpcRoute.StatefulSessionAffinityPolicy
Returns
Type Description
GrpcRoute.StatefulSessionAffinityPolicy.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GrpcRoute.StatefulSessionAffinityPolicy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GrpcRoute.StatefulSessionAffinityPolicy.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public GrpcRoute.StatefulSessionAffinityPolicy.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
GrpcRoute.StatefulSessionAffinityPolicy.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GrpcRoute.StatefulSessionAffinityPolicy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GrpcRoute.StatefulSessionAffinityPolicy.Builder
Overrides

setCookieTtl(Duration value)

public GrpcRoute.StatefulSessionAffinityPolicy.Builder setCookieTtl(Duration value)

Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 0 to 86400 seconds (24 hours) inclusive.

Set this to 0s to use a session cookie and disable cookie expiration.

.google.protobuf.Duration cookie_ttl = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Duration
Returns
Type Description
GrpcRoute.StatefulSessionAffinityPolicy.Builder

setCookieTtl(Duration.Builder builderForValue)

public GrpcRoute.StatefulSessionAffinityPolicy.Builder setCookieTtl(Duration.Builder builderForValue)

Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 0 to 86400 seconds (24 hours) inclusive.

Set this to 0s to use a session cookie and disable cookie expiration.

.google.protobuf.Duration cookie_ttl = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
GrpcRoute.StatefulSessionAffinityPolicy.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public GrpcRoute.StatefulSessionAffinityPolicy.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GrpcRoute.StatefulSessionAffinityPolicy.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public GrpcRoute.StatefulSessionAffinityPolicy.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
GrpcRoute.StatefulSessionAffinityPolicy.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final GrpcRoute.StatefulSessionAffinityPolicy.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GrpcRoute.StatefulSessionAffinityPolicy.Builder
Overrides