Class: Google::Apis::RunV1::Probe

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/run_v1/classes.rb,
lib/google/apis/run_v1/representations.rb,
lib/google/apis/run_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Probe

Returns a new instance of Probe.



4527
4528
4529
 
# File 'lib/google/apis/run_v1/classes.rb', line 4527

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#exec ⇒ Google::Apis::RunV1::ExecAction

Not supported by Cloud Run. ExecAction describes a "run in container" action. Corresponds to the JSON property exec

Returns:



4477
4478
4479
 
# File 'lib/google/apis/run_v1/classes.rb', line 4477

def exec
  @exec
end

#failure_threshold ⇒ Fixnum

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

Returns:

  • (Fixnum) 


4483
4484
4485
 
# File 'lib/google/apis/run_v1/classes.rb', line 4483

def failure_threshold
  @failure_threshold
end

#grpc ⇒ Google::Apis::RunV1::GrpcAction

GRPCAction describes an action involving a GRPC port. Corresponds to the JSON property grpc

Returns:



4488
4489
4490
 
# File 'lib/google/apis/run_v1/classes.rb', line 4488

def grpc
  @grpc
end

#http_get ⇒ Google::Apis::RunV1::HttpGetAction

HTTPGetAction describes an action based on HTTP Get requests. Corresponds to the JSON property httpGet

Returns:



4493
4494
4495
 
# File 'lib/google/apis/run_v1/classes.rb', line 4493

def http_get
  @http_get
end

#initial_delay_seconds ⇒ Fixnum

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. Corresponds to the JSON property initialDelaySeconds

Returns:

  • (Fixnum) 


4500
4501
4502
 
# File 'lib/google/apis/run_v1/classes.rb', line 4500

def initial_delay_seconds
  @initial_delay_seconds
end

#period_seconds ⇒ Fixnum

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. Corresponds to the JSON property periodSeconds

Returns:

  • (Fixnum) 


4507
4508
4509
 
# File 'lib/google/apis/run_v1/classes.rb', line 4507

def period_seconds
  @period_seconds
end

#success_threshold ⇒ Fixnum

Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 if set. Corresponds to the JSON property successThreshold

Returns:

  • (Fixnum) 


4513
4514
4515
 
# File 'lib/google/apis/run_v1/classes.rb', line 4513

def success_threshold
  @success_threshold
end

#tcp_socket ⇒ Google::Apis::RunV1::TcpSocketAction

TCPSocketAction describes an action based on opening a socket Corresponds to the JSON property tcpSocket

Returns:



4518
4519
4520
 
# File 'lib/google/apis/run_v1/classes.rb', line 4518

def tcp_socket
  @tcp_socket
end

#timeout_seconds ⇒ Fixnum

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; if period_seconds is not set, must be less or equal than 10. Corresponds to the JSON property timeoutSeconds

Returns:

  • (Fixnum) 


4525
4526
4527
 
# File 'lib/google/apis/run_v1/classes.rb', line 4525

def timeout_seconds
  @timeout_seconds
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
 
# File 'lib/google/apis/run_v1/classes.rb', line 4532

def update!(**args)
  @exec = args[:exec] if args.key?(:exec)
  @failure_threshold = args[:failure_threshold] if args.key?(:failure_threshold)
  @grpc = args[:grpc] if args.key?(:grpc)
  @http_get = args[:http_get] if args.key?(:http_get)
  @initial_delay_seconds = args[:initial_delay_seconds] if args.key?(:initial_delay_seconds)
  @period_seconds = args[:period_seconds] if args.key?(:period_seconds)
  @success_threshold = args[:success_threshold] if args.key?(:success_threshold)
  @tcp_socket = args[:tcp_socket] if args.key?(:tcp_socket)
  @timeout_seconds = args[:timeout_seconds] if args.key?(:timeout_seconds)
end