Class: Google::Cloud::Compute::V1::HealthCheck

Inherits:

Object

• Object
• Google::Cloud::Compute::V1::HealthCheck

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/compute/v1/compute.rb

Overview

Represents a Health Check resource. Google Compute Engine has two Health Check resources: * Global * Regional Internal HTTP(S) load balancers must use regional health checks (compute.v1.regionHealthChecks). Traffic Director must use global health checks (compute.v1.HealthChecks). Internal TCP/UDP load balancers can use either regional or global health checks (compute.v1.regionHealthChecks or compute.v1.HealthChecks). External HTTP(S), TCP proxy, and SSL proxy load balancers as well as managed instance group auto-healing must use global health checks (compute.v1.HealthChecks). Backend service-based network load balancers must use regional health checks (compute.v1.regionHealthChecks). Target pool-based network load balancers must use legacy HTTP health checks (compute.v1.httpHealthChecks). For more information, see Health checks overview.

Defined Under Namespace

Modules: Type

Instance Attribute Summary

• #check_interval_sec ⇒ ::Integer

  How often (in seconds) to send a health check.

• #creation_timestamp ⇒ ::String

  [Output Only] Creation timestamp in 3339 text format.

• #description ⇒ ::String

  An optional description of this resource.

• #grpc_health_check ⇒ ::Google::Cloud::Compute::V1::GRPCHealthCheck
• #healthy_threshold ⇒ ::Integer

  A so-far unhealthy instance will be marked healthy after this many consecutive successes.

• #http2_health_check ⇒ ::Google::Cloud::Compute::V1::HTTP2HealthCheck
• #http_health_check ⇒ ::Google::Cloud::Compute::V1::HTTPHealthCheck
• #https_health_check ⇒ ::Google::Cloud::Compute::V1::HTTPSHealthCheck
• #id ⇒ ::Integer

  [Output Only] The unique identifier for the resource.

• #kind ⇒ ::String

  Type of the resource.

• #log_config ⇒ ::Google::Cloud::Compute::V1::HealthCheckLogConfig

  Configure logging on this health check.

• #name ⇒ ::String

  Name of the resource.

• #region ⇒ ::String

  [Output Only] Region where the health check resides.

• #self_link ⇒ ::String

  [Output Only] Server-defined URL for the resource.

• #ssl_health_check ⇒ ::Google::Cloud::Compute::V1::SSLHealthCheck
• #tcp_health_check ⇒ ::Google::Cloud::Compute::V1::TCPHealthCheck
• #timeout_sec ⇒ ::Integer

  How long (in seconds) to wait before claiming failure.

• #type ⇒ ::String

  Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC.

• #unhealthy_threshold ⇒ ::Integer

  A so-far healthy instance will be marked unhealthy after this many consecutive failures.

Instance Attribute Details

#check_interval_sec ⇒ ::Integer

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 9766

class HealthCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    GRPC = 2196510

    HTTP = 2228360

    HTTP2 = 69079210

    HTTPS = 69079243

    INVALID = 530283991

    SSL = 82412

    TCP = 82881
  end
end

#creation_timestamp ⇒ ::String

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 9766

class HealthCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    GRPC = 2196510

    HTTP = 2228360

    HTTP2 = 69079210

    HTTPS = 69079243

    INVALID = 530283991

    SSL = 82412

    TCP = 82881
  end
end

#description ⇒ ::String

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 9766

class HealthCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    GRPC = 2196510

    HTTP = 2228360

    HTTP2 = 69079210

    HTTPS = 69079243

    INVALID = 530283991

    SSL = 82412

    TCP = 82881
  end
end

#grpc_health_check ⇒ ::Google::Cloud::Compute::V1::GRPCHealthCheck

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 9766

class HealthCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    GRPC = 2196510

    HTTP = 2228360

    HTTP2 = 69079210

    HTTPS = 69079243

    INVALID = 530283991

    SSL = 82412

    TCP = 82881
  end
end

#healthy_threshold ⇒ ::Integer

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 9766

class HealthCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    GRPC = 2196510

    HTTP = 2228360

    HTTP2 = 69079210

    HTTPS = 69079243

    INVALID = 530283991

    SSL = 82412

    TCP = 82881
  end
end

#http2_health_check ⇒ ::Google::Cloud::Compute::V1::HTTP2HealthCheck

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 9766

class HealthCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    GRPC = 2196510

    HTTP = 2228360

    HTTP2 = 69079210

    HTTPS = 69079243

    INVALID = 530283991

    SSL = 82412

    TCP = 82881
  end
end

#http_health_check ⇒ ::Google::Cloud::Compute::V1::HTTPHealthCheck

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 9766

class HealthCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    GRPC = 2196510

    HTTP = 2228360

    HTTP2 = 69079210

    HTTPS = 69079243

    INVALID = 530283991

    SSL = 82412

    TCP = 82881
  end
end

#https_health_check ⇒ ::Google::Cloud::Compute::V1::HTTPSHealthCheck

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 9766

class HealthCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    GRPC = 2196510

    HTTP = 2228360

    HTTP2 = 69079210

    HTTPS = 69079243

    INVALID = 530283991

    SSL = 82412

    TCP = 82881
  end
end

#id ⇒ ::Integer

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 9766

class HealthCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    GRPC = 2196510

    HTTP = 2228360

    HTTP2 = 69079210

    HTTPS = 69079243

    INVALID = 530283991

    SSL = 82412

    TCP = 82881
  end
end

#kind ⇒ ::String

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 9766

class HealthCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    GRPC = 2196510

    HTTP = 2228360

    HTTP2 = 69079210

    HTTPS = 69079243

    INVALID = 530283991

    SSL = 82412

    TCP = 82881
  end
end

#log_config ⇒ ::Google::Cloud::Compute::V1::HealthCheckLogConfig

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 9766

class HealthCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    GRPC = 2196510

    HTTP = 2228360

    HTTP2 = 69079210

    HTTPS = 69079243

    INVALID = 530283991

    SSL = 82412

    TCP = 82881
  end
end

#name ⇒ ::String

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 9766

class HealthCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    GRPC = 2196510

    HTTP = 2228360

    HTTP2 = 69079210

    HTTPS = 69079243

    INVALID = 530283991

    SSL = 82412

    TCP = 82881
  end
end

#region ⇒ ::String

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 9766

class HealthCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    GRPC = 2196510

    HTTP = 2228360

    HTTP2 = 69079210

    HTTPS = 69079243

    INVALID = 530283991

    SSL = 82412

    TCP = 82881
  end
end

#self_link ⇒ ::String

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 9766

class HealthCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    GRPC = 2196510

    HTTP = 2228360

    HTTP2 = 69079210

    HTTPS = 69079243

    INVALID = 530283991

    SSL = 82412

    TCP = 82881
  end
end

#ssl_health_check ⇒ ::Google::Cloud::Compute::V1::SSLHealthCheck

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 9766

class HealthCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    GRPC = 2196510

    HTTP = 2228360

    HTTP2 = 69079210

    HTTPS = 69079243

    INVALID = 530283991

    SSL = 82412

    TCP = 82881
  end
end

#tcp_health_check ⇒ ::Google::Cloud::Compute::V1::TCPHealthCheck

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 9766

class HealthCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    GRPC = 2196510

    HTTP = 2228360

    HTTP2 = 69079210

    HTTPS = 69079243

    INVALID = 530283991

    SSL = 82412

    TCP = 82881
  end
end

#timeout_sec ⇒ ::Integer

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 9766

class HealthCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    GRPC = 2196510

    HTTP = 2228360

    HTTP2 = 69079210

    HTTPS = 69079243

    INVALID = 530283991

    SSL = 82412

    TCP = 82881
  end
end

#type ⇒ ::String

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 9766

class HealthCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    GRPC = 2196510

    HTTP = 2228360

    HTTP2 = 69079210

    HTTPS = 69079243

    INVALID = 530283991

    SSL = 82412

    TCP = 82881
  end
end

#unhealthy_threshold ⇒ ::Integer

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 9766

class HealthCheck
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field.
  module Type
    # A value indicating that the enum field is not set.
    UNDEFINED_TYPE = 0

    GRPC = 2196510

    HTTP = 2228360

    HTTP2 = 69079210

    HTTPS = 69079243

    INVALID = 530283991

    SSL = 82412

    TCP = 82881
  end
end