Class: Google::Apis::RunV1alpha1::Probe

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

Overview

Not supported by Cloud Run 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.



1523
1524
1525
 
# File 'lib/google/apis/run_v1alpha1/classes.rb', line 1523

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

Instance Attribute Details

#exec ⇒ Google::Apis::RunV1alpha1::ExecAction

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

Returns:



1467
1468
1469
 
# File 'lib/google/apis/run_v1alpha1/classes.rb', line 1467

def exec
  @exec
end

#failure_threshold ⇒ Fixnum

(Optional) 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) 


1473
1474
1475
 
# File 'lib/google/apis/run_v1alpha1/classes.rb', line 1473

def failure_threshold
  @failure_threshold
end

#grpc ⇒ Google::Apis::RunV1alpha1::GrpcAction

Not supported by Cloud Run GRPCAction describes an action involving a GRPC port. Corresponds to the JSON property grpc

Returns:



1479
1480
1481
 
# File 'lib/google/apis/run_v1alpha1/classes.rb', line 1479

def grpc
  @grpc
end

#http_get ⇒ Google::Apis::RunV1alpha1::HttpGetAction

Not supported by Cloud Run HTTPGetAction describes an action based on HTTP Get requests. Corresponds to the JSON property httpGet

Returns:



1485
1486
1487
 
# File 'lib/google/apis/run_v1alpha1/classes.rb', line 1485

def http_get
  @http_get
end

#initial_delay_seconds ⇒ Fixnum

(Optional) 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. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container- probes Corresponds to the JSON property initialDelaySeconds

Returns:

  • (Fixnum) 


1494
1495
1496
 
# File 'lib/google/apis/run_v1alpha1/classes.rb', line 1494

def initial_delay_seconds
  @initial_delay_seconds
end

#period_seconds ⇒ Fixnum

(Optional) 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) 


1501
1502
1503
 
# File 'lib/google/apis/run_v1alpha1/classes.rb', line 1501

def period_seconds
  @period_seconds
end

#success_threshold ⇒ Fixnum

(Optional) 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) 


1507
1508
1509
 
# File 'lib/google/apis/run_v1alpha1/classes.rb', line 1507

def success_threshold
  @success_threshold
end

#tcp_socket ⇒ Google::Apis::RunV1alpha1::TcpSocketAction

Not supported by Cloud Run TCPSocketAction describes an action based on opening a socket Corresponds to the JSON property tcpSocket

Returns:



1513
1514
1515
 
# File 'lib/google/apis/run_v1alpha1/classes.rb', line 1513

def tcp_socket
  @tcp_socket
end

#timeout_seconds ⇒ Fixnum

(Optional) 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. More info: https://kubernetes.io/docs/concepts/workloads/pods/ pod-lifecycle#container-probes Corresponds to the JSON property timeoutSeconds

Returns:

  • (Fixnum) 


1521
1522
1523
 
# File 'lib/google/apis/run_v1alpha1/classes.rb', line 1521

def timeout_seconds
  @timeout_seconds
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
 
# File 'lib/google/apis/run_v1alpha1/classes.rb', line 1528

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