Class Probe.Builder (3.35.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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Probe.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Probe.Builder
Overrides

build()

public Probe build()
Returns
TypeDescription
Probe

buildPartial()

public Probe buildPartial()
Returns
TypeDescription
Probe

clear()

public Probe.Builder clear()
Returns
TypeDescription
Probe.Builder
Overrides

clearExec()

public Probe.Builder clearExec()

Exec specifies the action to take.

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

Returns
TypeDescription
Probe.Builder

clearField(Descriptors.FieldDescriptor field)

public Probe.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Probe.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public Probe.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
Probe.Builder

This builder for chaining.

clearProbeType()

public Probe.Builder clearProbeType()
Returns
TypeDescription
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
TypeDescription
Probe.Builder

This builder for chaining.

clone()

public Probe.Builder clone()
Returns
TypeDescription
Probe.Builder
Overrides

getDefaultInstanceForType()

public Probe getDefaultInstanceForType()
Returns
TypeDescription
Probe

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getExec()

public Probe.ExecAction getExec()

Exec specifies the action to take.

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

Returns
TypeDescription
Probe.ExecAction

The exec.

getExecBuilder()

public Probe.ExecAction.Builder getExecBuilder()

Exec specifies the action to take.

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

Returns
TypeDescription
Probe.ExecAction.Builder

getExecOrBuilder()

public Probe.ExecActionOrBuilder getExecOrBuilder()

Exec specifies the action to take.

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

Returns
TypeDescription
Probe.ExecActionOrBuilder

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
TypeDescription
int

The periodSeconds.

getProbeTypeCase()

public Probe.ProbeTypeCase getProbeTypeCase()
Returns
TypeDescription
Probe.ProbeTypeCase

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
TypeDescription
int

The timeoutSeconds.

hasExec()

public boolean hasExec()

Exec specifies the action to take.

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

Returns
TypeDescription
boolean

Whether the exec field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeExec(Probe.ExecAction value)

public Probe.Builder mergeExec(Probe.ExecAction value)

Exec specifies the action to take.

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

Parameter
NameDescription
valueProbe.ExecAction
Returns
TypeDescription
Probe.Builder

mergeFrom(Probe other)

public Probe.Builder mergeFrom(Probe other)
Parameter
NameDescription
otherProbe
Returns
TypeDescription
Probe.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Probe.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Probe.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Probe.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Probe.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Probe.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Probe.Builder
Overrides

setExec(Probe.ExecAction value)

public Probe.Builder setExec(Probe.ExecAction value)

Exec specifies the action to take.

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

Parameter
NameDescription
valueProbe.ExecAction
Returns
TypeDescription
Probe.Builder

setExec(Probe.ExecAction.Builder builderForValue)

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

Exec specifies the action to take.

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

Parameter
NameDescription
builderForValueProbe.ExecAction.Builder
Returns
TypeDescription
Probe.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Probe.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Probe.Builder
Overrides

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
NameDescription
valueint

The periodSeconds to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Probe.Builder
Overrides

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
NameDescription
valueint

The timeoutSeconds to set.

Returns
TypeDescription
Probe.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Probe.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Probe.Builder
Overrides