Class: Google::Cloud::Connectors::V1::ConnectionStatus

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/connectors/v1/connection.rb

Overview

ConnectionStatus indicates the state of the connection.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ ::String

Returns Description.

Returns:

  • (::String) —

    Description.



493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
 
# File 'proto_docs/google/cloud/connectors/v1/connection.rb', line 493

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

  # All the possible Connection State.
  module State
    # Connection does not have a state yet.
    STATE_UNSPECIFIED = 0

    # Connection is being created.
    CREATING = 1

    # Connection is running and ready for requests.
    ACTIVE = 2

    # Connection is stopped.
    INACTIVE = 3

    # Connection is being deleted.
    DELETING = 4

    # Connection is being updated.
    UPDATING = 5

    # Connection is not running due to an error.
    ERROR = 6

    # Connection is not running due to an auth error for the Oauth2 Auth Code
    # based connector.
    AUTHORIZATION_REQUIRED = 7
  end
end

#state ⇒ ::Google::Cloud::Connectors::V1::ConnectionStatus::State

Returns State.

Returns:



493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
 
# File 'proto_docs/google/cloud/connectors/v1/connection.rb', line 493

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

  # All the possible Connection State.
  module State
    # Connection does not have a state yet.
    STATE_UNSPECIFIED = 0

    # Connection is being created.
    CREATING = 1

    # Connection is running and ready for requests.
    ACTIVE = 2

    # Connection is stopped.
    INACTIVE = 3

    # Connection is being deleted.
    DELETING = 4

    # Connection is being updated.
    UPDATING = 5

    # Connection is not running due to an error.
    ERROR = 6

    # Connection is not running due to an auth error for the Oauth2 Auth Code
    # based connector.
    AUTHORIZATION_REQUIRED = 7
  end
end

#status ⇒ ::String

Returns Status provides detailed information for the state.

Returns:

  • (::String) —

    Status provides detailed information for the state.



493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
 
# File 'proto_docs/google/cloud/connectors/v1/connection.rb', line 493

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

  # All the possible Connection State.
  module State
    # Connection does not have a state yet.
    STATE_UNSPECIFIED = 0

    # Connection is being created.
    CREATING = 1

    # Connection is running and ready for requests.
    ACTIVE = 2

    # Connection is stopped.
    INACTIVE = 3

    # Connection is being deleted.
    DELETING = 4

    # Connection is being updated.
    UPDATING = 5

    # Connection is not running due to an error.
    ERROR = 6

    # Connection is not running due to an auth error for the Oauth2 Auth Code
    # based connector.
    AUTHORIZATION_REQUIRED = 7
  end
end