Class Probe.Builder (0.32.0)

Version 0.32.0

• 0.52.0 (latest)
• 0.51.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.5
• 0.2.1
• 0.1.2

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.run.v2.Probe

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Probe.Builder

Implements

ProbeOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

clearFailureThreshold()

public Probe.Builder clearFailureThreshold()

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

int32 failure_threshold = 4;

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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearGrpc()

public Probe.Builder clearGrpc()

GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.

.google.cloud.run.v2.GRPCAction grpc = 7;

Returns
Type	Description
Probe.Builder

clearHttpGet()

public Probe.Builder clearHttpGet()

HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.

.google.cloud.run.v2.HTTPGetAction http_get = 5;

Returns
Type	Description
Probe.Builder

clearInitialDelaySeconds()

public Probe.Builder clearInitialDelaySeconds()

Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.

int32 initial_delay_seconds = 1;

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

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearPeriodSeconds()

public Probe.Builder clearPeriodSeconds()

How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.

int32 period_seconds = 3;

Returns
Type	Description
Probe.Builder	This builder for chaining.

clearProbeType()

public Probe.Builder clearProbeType()

Returns
Type	Description
Probe.Builder

clearTcpSocket()

public Probe.Builder clearTcpSocket()

TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.

.google.cloud.run.v2.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. Maximum value is 3600. Must be smaller than period_seconds.

int32 timeout_seconds = 2;

Returns
Type	Description
Probe.Builder	This builder for chaining.

clone()

public Probe.Builder clone()

Returns
Type	Description
Probe.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public Probe getDefaultInstanceForType()

Returns
Type	Description
Probe

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFailureThreshold()

public int getFailureThreshold()

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

int32 failure_threshold = 4;

Returns
Type	Description
int	The failureThreshold.

getGrpc()

public GRPCAction getGrpc()

GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.

.google.cloud.run.v2.GRPCAction grpc = 7;

Returns
Type	Description
GRPCAction	The grpc.

getGrpcBuilder()

public GRPCAction.Builder getGrpcBuilder()

GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.

.google.cloud.run.v2.GRPCAction grpc = 7;

Returns
Type	Description
GRPCAction.Builder

getGrpcOrBuilder()

public GRPCActionOrBuilder getGrpcOrBuilder()

GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.

.google.cloud.run.v2.GRPCAction grpc = 7;

Returns
Type	Description
GRPCActionOrBuilder

getHttpGet()

public HTTPGetAction getHttpGet()

HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.

.google.cloud.run.v2.HTTPGetAction http_get = 5;

Returns
Type	Description
HTTPGetAction	The httpGet.

getHttpGetBuilder()

public HTTPGetAction.Builder getHttpGetBuilder()

HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.

.google.cloud.run.v2.HTTPGetAction http_get = 5;

Returns
Type	Description
HTTPGetAction.Builder

getHttpGetOrBuilder()

public HTTPGetActionOrBuilder getHttpGetOrBuilder()

HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.

.google.cloud.run.v2.HTTPGetAction http_get = 5;

Returns
Type	Description
HTTPGetActionOrBuilder

getInitialDelaySeconds()

public int getInitialDelaySeconds()

Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.

int32 initial_delay_seconds = 1;

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. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.

int32 period_seconds = 3;

Returns
Type	Description
int	The periodSeconds.

getProbeTypeCase()

public Probe.ProbeTypeCase getProbeTypeCase()

Returns
Type	Description
Probe.ProbeTypeCase

getTcpSocket()

public TCPSocketAction getTcpSocket()

TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.

.google.cloud.run.v2.TCPSocketAction tcp_socket = 6;

Returns
Type	Description
TCPSocketAction	The tcpSocket.

getTcpSocketBuilder()

public TCPSocketAction.Builder getTcpSocketBuilder()

TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.

.google.cloud.run.v2.TCPSocketAction tcp_socket = 6;

Returns
Type	Description
TCPSocketAction.Builder

getTcpSocketOrBuilder()

public TCPSocketActionOrBuilder getTcpSocketOrBuilder()

TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.

.google.cloud.run.v2.TCPSocketAction tcp_socket = 6;

Returns
Type	Description
TCPSocketActionOrBuilder

getTimeoutSeconds()

public int getTimeoutSeconds()

Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 3600. Must be smaller than period_seconds.

int32 timeout_seconds = 2;

Returns
Type	Description
int	The timeoutSeconds.

hasGrpc()

public boolean hasGrpc()

GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.

.google.cloud.run.v2.GRPCAction grpc = 7;

Returns
Type	Description
boolean	Whether the grpc field is set.

hasHttpGet()

public boolean hasHttpGet()

HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.

.google.cloud.run.v2.HTTPGetAction http_get = 5;

Returns
Type	Description
boolean	Whether the httpGet field is set.

hasTcpSocket()

public boolean hasTcpSocket()

TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.

.google.cloud.run.v2.TCPSocketAction tcp_socket = 6;

Returns
Type	Description
boolean	Whether the tcpSocket field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Probe.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Probe.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeGrpc(GRPCAction value)

public Probe.Builder mergeGrpc(GRPCAction value)

GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.

.google.cloud.run.v2.GRPCAction grpc = 7;

Parameter
Name	Description
value	GRPCAction

Returns
Type	Description
Probe.Builder

mergeHttpGet(HTTPGetAction value)

public Probe.Builder mergeHttpGet(HTTPGetAction value)

HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.

.google.cloud.run.v2.HTTPGetAction http_get = 5;

Parameter
Name	Description
value	HTTPGetAction

Returns
Type	Description
Probe.Builder

mergeTcpSocket(TCPSocketAction value)

public Probe.Builder mergeTcpSocket(TCPSocketAction value)

TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.

.google.cloud.run.v2.TCPSocketAction tcp_socket = 6;

Parameter
Name	Description
value	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

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setFailureThreshold(int value)

public Probe.Builder setFailureThreshold(int value)

Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1.

int32 failure_threshold = 4;

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setGrpc(GRPCAction value)

public Probe.Builder setGrpc(GRPCAction value)

GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.

.google.cloud.run.v2.GRPCAction grpc = 7;

Parameter
Name	Description
value	GRPCAction

Returns
Type	Description
Probe.Builder

setGrpc(GRPCAction.Builder builderForValue)

public Probe.Builder setGrpc(GRPCAction.Builder builderForValue)

GRPC specifies an action involving a gRPC port. Exactly one of httpGet, tcpSocket, or grpc must be specified.

.google.cloud.run.v2.GRPCAction grpc = 7;

Parameter
Name	Description
builderForValue	GRPCAction.Builder

Returns
Type	Description
Probe.Builder

setHttpGet(HTTPGetAction value)

public Probe.Builder setHttpGet(HTTPGetAction value)

HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.

.google.cloud.run.v2.HTTPGetAction http_get = 5;

Parameter
Name	Description
value	HTTPGetAction

Returns
Type	Description
Probe.Builder

setHttpGet(HTTPGetAction.Builder builderForValue)

public Probe.Builder setHttpGet(HTTPGetAction.Builder builderForValue)

HTTPGet specifies the http request to perform. Exactly one of httpGet, tcpSocket, or grpc must be specified.

.google.cloud.run.v2.HTTPGetAction http_get = 5;

Parameter
Name	Description
builderForValue	HTTPGetAction.Builder

Returns
Type	Description
Probe.Builder

setInitialDelaySeconds(int value)

public Probe.Builder setInitialDelaySeconds(int value)

Number of seconds after the container has started before the probe is initiated. Defaults to 0 seconds. Minimum value is 0. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240.

int32 initial_delay_seconds = 1;

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. Maximum value for liveness probe is 3600. Maximum value for startup probe is 240. Must be greater or equal than timeout_seconds.

int32 period_seconds = 3;

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setTcpSocket(TCPSocketAction value)

public Probe.Builder setTcpSocket(TCPSocketAction value)

TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.

.google.cloud.run.v2.TCPSocketAction tcp_socket = 6;

Parameter
Name	Description
value	TCPSocketAction

Returns
Type	Description
Probe.Builder

setTcpSocket(TCPSocketAction.Builder builderForValue)

public Probe.Builder setTcpSocket(TCPSocketAction.Builder builderForValue)

TCPSocket specifies an action involving a TCP port. Exactly one of httpGet, tcpSocket, or grpc must be specified.

.google.cloud.run.v2.TCPSocketAction tcp_socket = 6;

Parameter
Name	Description
builderForValue	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. Maximum value is 3600. Must be smaller than period_seconds.

int32 timeout_seconds = 2;

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

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)