Class Probe.Builder (3.59.0)

public static final class Probe.Builder extends GeneratedMessageV3.Builder<Probe.Builder> implements ProbeOrBuilder

Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.

Protobuf type google.cloud.aiplatform.v1.Probe

Implements

ProbeOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Probe build()
Returns
Type Description
Probe

buildPartial()

public Probe buildPartial()
Returns
Type Description
Probe

clear()

public Probe.Builder clear()
Returns
Type Description
Probe.Builder
Overrides

clearExec()

public Probe.Builder clearExec()

ExecAction probes the health of a container by executing a command.

.google.cloud.aiplatform.v1.Probe.ExecAction exec = 1;

Returns
Type Description
Probe.Builder

clearFailureThreshold()

public Probe.Builder clearFailureThreshold()

Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1.

Maps to Kubernetes probe argument 'failureThreshold'.

int32 failure_threshold = 7;

Returns
Type Description
Probe.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearGrpc()

public Probe.Builder clearGrpc()

GrpcAction probes the health of a container by sending a gRPC request.

.google.cloud.aiplatform.v1.Probe.GrpcAction grpc = 5;

Returns
Type Description
Probe.Builder

clearHttpGet()

public Probe.Builder clearHttpGet()

HttpGetAction probes the health of a container by sending an HTTP GET request.

.google.cloud.aiplatform.v1.Probe.HttpGetAction http_get = 4;

Returns
Type Description
Probe.Builder

clearInitialDelaySeconds()

public Probe.Builder clearInitialDelaySeconds()

Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0.

Maps to Kubernetes probe argument 'initialDelaySeconds'.

int32 initial_delay_seconds = 9;

Returns
Type Description
Probe.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPeriodSeconds()

public Probe.Builder clearPeriodSeconds()

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds.

Maps to Kubernetes probe argument 'periodSeconds'.

int32 period_seconds = 2;

Returns
Type Description
Probe.Builder

This builder for chaining.

clearProbeType()

public Probe.Builder clearProbeType()
Returns
Type Description
Probe.Builder

clearSuccessThreshold()

public Probe.Builder clearSuccessThreshold()

Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1.

Maps to Kubernetes probe argument 'successThreshold'.

int32 success_threshold = 8;

Returns
Type Description
Probe.Builder

This builder for chaining.

clearTcpSocket()

public Probe.Builder clearTcpSocket()

TcpSocketAction probes the health of a container by opening a TCP socket connection.

.google.cloud.aiplatform.v1.Probe.TcpSocketAction tcp_socket = 6;

Returns
Type Description
Probe.Builder

clearTimeoutSeconds()

public Probe.Builder clearTimeoutSeconds()

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds.

Maps to Kubernetes probe argument 'timeoutSeconds'.

int32 timeout_seconds = 3;

Returns
Type Description
Probe.Builder

This builder for chaining.

clone()

public Probe.Builder clone()
Returns
Type Description
Probe.Builder
Overrides

getDefaultInstanceForType()

public Probe getDefaultInstanceForType()
Returns
Type Description
Probe

getDescriptorForType()

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

getExec()

public Probe.ExecAction getExec()

ExecAction probes the health of a container by executing a command.

.google.cloud.aiplatform.v1.Probe.ExecAction exec = 1;

Returns
Type Description
Probe.ExecAction

The exec.

getExecBuilder()

public Probe.ExecAction.Builder getExecBuilder()

ExecAction probes the health of a container by executing a command.

.google.cloud.aiplatform.v1.Probe.ExecAction exec = 1;

Returns
Type Description
Probe.ExecAction.Builder

getExecOrBuilder()

public Probe.ExecActionOrBuilder getExecOrBuilder()

ExecAction probes the health of a container by executing a command.

.google.cloud.aiplatform.v1.Probe.ExecAction exec = 1;

Returns
Type Description
Probe.ExecActionOrBuilder

getFailureThreshold()

public int getFailureThreshold()

Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1.

Maps to Kubernetes probe argument 'failureThreshold'.

int32 failure_threshold = 7;

Returns
Type Description
int

The failureThreshold.

getGrpc()

public Probe.GrpcAction getGrpc()

GrpcAction probes the health of a container by sending a gRPC request.

.google.cloud.aiplatform.v1.Probe.GrpcAction grpc = 5;

Returns
Type Description
Probe.GrpcAction

The grpc.

getGrpcBuilder()

public Probe.GrpcAction.Builder getGrpcBuilder()

GrpcAction probes the health of a container by sending a gRPC request.

.google.cloud.aiplatform.v1.Probe.GrpcAction grpc = 5;

Returns
Type Description
Probe.GrpcAction.Builder

getGrpcOrBuilder()

public Probe.GrpcActionOrBuilder getGrpcOrBuilder()

GrpcAction probes the health of a container by sending a gRPC request.

.google.cloud.aiplatform.v1.Probe.GrpcAction grpc = 5;

Returns
Type Description
Probe.GrpcActionOrBuilder

getHttpGet()

public Probe.HttpGetAction getHttpGet()

HttpGetAction probes the health of a container by sending an HTTP GET request.

.google.cloud.aiplatform.v1.Probe.HttpGetAction http_get = 4;

Returns
Type Description
Probe.HttpGetAction

The httpGet.

getHttpGetBuilder()

public Probe.HttpGetAction.Builder getHttpGetBuilder()

HttpGetAction probes the health of a container by sending an HTTP GET request.

.google.cloud.aiplatform.v1.Probe.HttpGetAction http_get = 4;

Returns
Type Description
Probe.HttpGetAction.Builder

getHttpGetOrBuilder()

public Probe.HttpGetActionOrBuilder getHttpGetOrBuilder()

HttpGetAction probes the health of a container by sending an HTTP GET request.

.google.cloud.aiplatform.v1.Probe.HttpGetAction http_get = 4;

Returns
Type Description
Probe.HttpGetActionOrBuilder

getInitialDelaySeconds()

public int getInitialDelaySeconds()

Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0.

Maps to Kubernetes probe argument 'initialDelaySeconds'.

int32 initial_delay_seconds = 9;

Returns
Type Description
int

The initialDelaySeconds.

getPeriodSeconds()

public int getPeriodSeconds()

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds.

Maps to Kubernetes probe argument 'periodSeconds'.

int32 period_seconds = 2;

Returns
Type Description
int

The periodSeconds.

getProbeTypeCase()

public Probe.ProbeTypeCase getProbeTypeCase()
Returns
Type Description
Probe.ProbeTypeCase

getSuccessThreshold()

public int getSuccessThreshold()

Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1.

Maps to Kubernetes probe argument 'successThreshold'.

int32 success_threshold = 8;

Returns
Type Description
int

The successThreshold.

getTcpSocket()

public Probe.TcpSocketAction getTcpSocket()

TcpSocketAction probes the health of a container by opening a TCP socket connection.

.google.cloud.aiplatform.v1.Probe.TcpSocketAction tcp_socket = 6;

Returns
Type Description
Probe.TcpSocketAction

The tcpSocket.

getTcpSocketBuilder()

public Probe.TcpSocketAction.Builder getTcpSocketBuilder()

TcpSocketAction probes the health of a container by opening a TCP socket connection.

.google.cloud.aiplatform.v1.Probe.TcpSocketAction tcp_socket = 6;

Returns
Type Description
Probe.TcpSocketAction.Builder

getTcpSocketOrBuilder()

public Probe.TcpSocketActionOrBuilder getTcpSocketOrBuilder()

TcpSocketAction probes the health of a container by opening a TCP socket connection.

.google.cloud.aiplatform.v1.Probe.TcpSocketAction tcp_socket = 6;

Returns
Type Description
Probe.TcpSocketActionOrBuilder

getTimeoutSeconds()

public int getTimeoutSeconds()

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds.

Maps to Kubernetes probe argument 'timeoutSeconds'.

int32 timeout_seconds = 3;

Returns
Type Description
int

The timeoutSeconds.

hasExec()

public boolean hasExec()

ExecAction probes the health of a container by executing a command.

.google.cloud.aiplatform.v1.Probe.ExecAction exec = 1;

Returns
Type Description
boolean

Whether the exec field is set.

hasGrpc()

public boolean hasGrpc()

GrpcAction probes the health of a container by sending a gRPC request.

.google.cloud.aiplatform.v1.Probe.GrpcAction grpc = 5;

Returns
Type Description
boolean

Whether the grpc field is set.

hasHttpGet()

public boolean hasHttpGet()

HttpGetAction probes the health of a container by sending an HTTP GET request.

.google.cloud.aiplatform.v1.Probe.HttpGetAction http_get = 4;

Returns
Type Description
boolean

Whether the httpGet field is set.

hasTcpSocket()

public boolean hasTcpSocket()

TcpSocketAction probes the health of a container by opening a TCP socket connection.

.google.cloud.aiplatform.v1.Probe.TcpSocketAction tcp_socket = 6;

Returns
Type Description
boolean

Whether the tcpSocket field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeExec(Probe.ExecAction value)

public Probe.Builder mergeExec(Probe.ExecAction value)

ExecAction probes the health of a container by executing a command.

.google.cloud.aiplatform.v1.Probe.ExecAction exec = 1;

Parameter
Name Description
value Probe.ExecAction
Returns
Type Description
Probe.Builder

mergeFrom(Probe other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeGrpc(Probe.GrpcAction value)

public Probe.Builder mergeGrpc(Probe.GrpcAction value)

GrpcAction probes the health of a container by sending a gRPC request.

.google.cloud.aiplatform.v1.Probe.GrpcAction grpc = 5;

Parameter
Name Description
value Probe.GrpcAction
Returns
Type Description
Probe.Builder

mergeHttpGet(Probe.HttpGetAction value)

public Probe.Builder mergeHttpGet(Probe.HttpGetAction value)

HttpGetAction probes the health of a container by sending an HTTP GET request.

.google.cloud.aiplatform.v1.Probe.HttpGetAction http_get = 4;

Parameter
Name Description
value Probe.HttpGetAction
Returns
Type Description
Probe.Builder

mergeTcpSocket(Probe.TcpSocketAction value)

public Probe.Builder mergeTcpSocket(Probe.TcpSocketAction value)

TcpSocketAction probes the health of a container by opening a TCP socket connection.

.google.cloud.aiplatform.v1.Probe.TcpSocketAction tcp_socket = 6;

Parameter
Name Description
value Probe.TcpSocketAction
Returns
Type Description
Probe.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setExec(Probe.ExecAction value)

public Probe.Builder setExec(Probe.ExecAction value)

ExecAction probes the health of a container by executing a command.

.google.cloud.aiplatform.v1.Probe.ExecAction exec = 1;

Parameter
Name Description
value Probe.ExecAction
Returns
Type Description
Probe.Builder

setExec(Probe.ExecAction.Builder builderForValue)

public Probe.Builder setExec(Probe.ExecAction.Builder builderForValue)

ExecAction probes the health of a container by executing a command.

.google.cloud.aiplatform.v1.Probe.ExecAction exec = 1;

Parameter
Name Description
builderForValue Probe.ExecAction.Builder
Returns
Type Description
Probe.Builder

setFailureThreshold(int value)

public Probe.Builder setFailureThreshold(int value)

Number of consecutive failures before the probe is considered failed. Defaults to 3. Minimum value is 1.

Maps to Kubernetes probe argument 'failureThreshold'.

int32 failure_threshold = 7;

Parameter
Name Description
value int

The failureThreshold to set.

Returns
Type Description
Probe.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setGrpc(Probe.GrpcAction value)

public Probe.Builder setGrpc(Probe.GrpcAction value)

GrpcAction probes the health of a container by sending a gRPC request.

.google.cloud.aiplatform.v1.Probe.GrpcAction grpc = 5;

Parameter
Name Description
value Probe.GrpcAction
Returns
Type Description
Probe.Builder

setGrpc(Probe.GrpcAction.Builder builderForValue)

public Probe.Builder setGrpc(Probe.GrpcAction.Builder builderForValue)

GrpcAction probes the health of a container by sending a gRPC request.

.google.cloud.aiplatform.v1.Probe.GrpcAction grpc = 5;

Parameter
Name Description
builderForValue Probe.GrpcAction.Builder
Returns
Type Description
Probe.Builder

setHttpGet(Probe.HttpGetAction value)

public Probe.Builder setHttpGet(Probe.HttpGetAction value)

HttpGetAction probes the health of a container by sending an HTTP GET request.

.google.cloud.aiplatform.v1.Probe.HttpGetAction http_get = 4;

Parameter
Name Description
value Probe.HttpGetAction
Returns
Type Description
Probe.Builder

setHttpGet(Probe.HttpGetAction.Builder builderForValue)

public Probe.Builder setHttpGet(Probe.HttpGetAction.Builder builderForValue)

HttpGetAction probes the health of a container by sending an HTTP GET request.

.google.cloud.aiplatform.v1.Probe.HttpGetAction http_get = 4;

Parameter
Name Description
builderForValue Probe.HttpGetAction.Builder
Returns
Type Description
Probe.Builder

setInitialDelaySeconds(int value)

public Probe.Builder setInitialDelaySeconds(int value)

Number of seconds to wait before starting the probe. Defaults to 0. Minimum value is 0.

Maps to Kubernetes probe argument 'initialDelaySeconds'.

int32 initial_delay_seconds = 9;

Parameter
Name Description
value int

The initialDelaySeconds to set.

Returns
Type Description
Probe.Builder

This builder for chaining.

setPeriodSeconds(int value)

public Probe.Builder setPeriodSeconds(int value)

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Must be less than timeout_seconds.

Maps to Kubernetes probe argument 'periodSeconds'.

int32 period_seconds = 2;

Parameter
Name Description
value int

The periodSeconds to set.

Returns
Type Description
Probe.Builder

This builder for chaining.

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

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

setSuccessThreshold(int value)

public Probe.Builder setSuccessThreshold(int value)

Number of consecutive successes before the probe is considered successful. Defaults to 1. Minimum value is 1.

Maps to Kubernetes probe argument 'successThreshold'.

int32 success_threshold = 8;

Parameter
Name Description
value int

The successThreshold to set.

Returns
Type Description
Probe.Builder

This builder for chaining.

setTcpSocket(Probe.TcpSocketAction value)

public Probe.Builder setTcpSocket(Probe.TcpSocketAction value)

TcpSocketAction probes the health of a container by opening a TCP socket connection.

.google.cloud.aiplatform.v1.Probe.TcpSocketAction tcp_socket = 6;

Parameter
Name Description
value Probe.TcpSocketAction
Returns
Type Description
Probe.Builder

setTcpSocket(Probe.TcpSocketAction.Builder builderForValue)

public Probe.Builder setTcpSocket(Probe.TcpSocketAction.Builder builderForValue)

TcpSocketAction probes the health of a container by opening a TCP socket connection.

.google.cloud.aiplatform.v1.Probe.TcpSocketAction tcp_socket = 6;

Parameter
Name Description
builderForValue Probe.TcpSocketAction.Builder
Returns
Type Description
Probe.Builder

setTimeoutSeconds(int value)

public Probe.Builder setTimeoutSeconds(int value)

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Must be greater or equal to period_seconds.

Maps to Kubernetes probe argument 'timeoutSeconds'.

int32 timeout_seconds = 3;

Parameter
Name Description
value int

The timeoutSeconds to set.

Returns
Type Description
Probe.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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