Class: Google::Cloud::ApigeeRegistry::V1::Instance

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

Overview

An Instance represents the instance resources of the Registry. Currently, only one instance is allowed for each project.

Defined Under Namespace

Modules: State Classes: Config

Instance Attribute Summary collapse

Instance Attribute Details

#config ⇒ ::Google::Cloud::ApigeeRegistry::V1::Instance::Config

Returns Required. Config of the Instance.

Returns:



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'proto_docs/google/cloud/apigeeregistry/v1/provisioning_service.rb', line 111

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

  # Available configurations to provision an Instance.
  # @!attribute [r] location
  #   @return [::String]
  #     Output only. The GCP location where the Instance resides.
  # @!attribute [rw] cmek_key_name
  #   @return [::String]
  #     Required. The Customer Managed Encryption Key (CMEK) used for data encryption.
  #     The CMEK name should follow the format of
  #     `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`,
  #     where the `location` must match InstanceConfig.location.
  class Config
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the Instance.
  module State
    # The default value. This value is used if the state is omitted.
    STATE_UNSPECIFIED = 0

    # The Instance has not been initialized or has been deleted.
    INACTIVE = 1

    # The Instance is being created.
    CREATING = 2

    # The Instance has been created and is ready for use.
    ACTIVE = 3

    # The Instance is being updated.
    UPDATING = 4

    # The Instance is being deleted.
    DELETING = 5

    # The Instance encountered an error during a state change.
    FAILED = 6
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Creation timestamp.

Returns:



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'proto_docs/google/cloud/apigeeregistry/v1/provisioning_service.rb', line 111

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

  # Available configurations to provision an Instance.
  # @!attribute [r] location
  #   @return [::String]
  #     Output only. The GCP location where the Instance resides.
  # @!attribute [rw] cmek_key_name
  #   @return [::String]
  #     Required. The Customer Managed Encryption Key (CMEK) used for data encryption.
  #     The CMEK name should follow the format of
  #     `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`,
  #     where the `location` must match InstanceConfig.location.
  class Config
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the Instance.
  module State
    # The default value. This value is used if the state is omitted.
    STATE_UNSPECIFIED = 0

    # The Instance has not been initialized or has been deleted.
    INACTIVE = 1

    # The Instance is being created.
    CREATING = 2

    # The Instance has been created and is ready for use.
    ACTIVE = 3

    # The Instance is being updated.
    UPDATING = 4

    # The Instance is being deleted.
    DELETING = 5

    # The Instance encountered an error during a state change.
    FAILED = 6
  end
end

#name ⇒ ::String

Returns Format: projects/*/locations/*/instance. Currently only locations/global is supported.

Returns:

  • (::String) —

    Format: projects/*/locations/*/instance. Currently only locations/global is supported.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'proto_docs/google/cloud/apigeeregistry/v1/provisioning_service.rb', line 111

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

  # Available configurations to provision an Instance.
  # @!attribute [r] location
  #   @return [::String]
  #     Output only. The GCP location where the Instance resides.
  # @!attribute [rw] cmek_key_name
  #   @return [::String]
  #     Required. The Customer Managed Encryption Key (CMEK) used for data encryption.
  #     The CMEK name should follow the format of
  #     `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`,
  #     where the `location` must match InstanceConfig.location.
  class Config
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the Instance.
  module State
    # The default value. This value is used if the state is omitted.
    STATE_UNSPECIFIED = 0

    # The Instance has not been initialized or has been deleted.
    INACTIVE = 1

    # The Instance is being created.
    CREATING = 2

    # The Instance has been created and is ready for use.
    ACTIVE = 3

    # The Instance is being updated.
    UPDATING = 4

    # The Instance is being deleted.
    DELETING = 5

    # The Instance encountered an error during a state change.
    FAILED = 6
  end
end

#state ⇒ ::Google::Cloud::ApigeeRegistry::V1::Instance::State (readonly)

Returns Output only. The current state of the Instance.

Returns:



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'proto_docs/google/cloud/apigeeregistry/v1/provisioning_service.rb', line 111

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

  # Available configurations to provision an Instance.
  # @!attribute [r] location
  #   @return [::String]
  #     Output only. The GCP location where the Instance resides.
  # @!attribute [rw] cmek_key_name
  #   @return [::String]
  #     Required. The Customer Managed Encryption Key (CMEK) used for data encryption.
  #     The CMEK name should follow the format of
  #     `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`,
  #     where the `location` must match InstanceConfig.location.
  class Config
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the Instance.
  module State
    # The default value. This value is used if the state is omitted.
    STATE_UNSPECIFIED = 0

    # The Instance has not been initialized or has been deleted.
    INACTIVE = 1

    # The Instance is being created.
    CREATING = 2

    # The Instance has been created and is ready for use.
    ACTIVE = 3

    # The Instance is being updated.
    UPDATING = 4

    # The Instance is being deleted.
    DELETING = 5

    # The Instance encountered an error during a state change.
    FAILED = 6
  end
end

#state_message ⇒ ::String (readonly)

Returns Output only. Extra information of Instance.State if the state is FAILED.

Returns:

  • (::String) —

    Output only. Extra information of Instance.State if the state is FAILED.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'proto_docs/google/cloud/apigeeregistry/v1/provisioning_service.rb', line 111

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

  # Available configurations to provision an Instance.
  # @!attribute [r] location
  #   @return [::String]
  #     Output only. The GCP location where the Instance resides.
  # @!attribute [rw] cmek_key_name
  #   @return [::String]
  #     Required. The Customer Managed Encryption Key (CMEK) used for data encryption.
  #     The CMEK name should follow the format of
  #     `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`,
  #     where the `location` must match InstanceConfig.location.
  class Config
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the Instance.
  module State
    # The default value. This value is used if the state is omitted.
    STATE_UNSPECIFIED = 0

    # The Instance has not been initialized or has been deleted.
    INACTIVE = 1

    # The Instance is being created.
    CREATING = 2

    # The Instance has been created and is ready for use.
    ACTIVE = 3

    # The Instance is being updated.
    UPDATING = 4

    # The Instance is being deleted.
    DELETING = 5

    # The Instance encountered an error during a state change.
    FAILED = 6
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Last update timestamp.

Returns:



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'proto_docs/google/cloud/apigeeregistry/v1/provisioning_service.rb', line 111

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

  # Available configurations to provision an Instance.
  # @!attribute [r] location
  #   @return [::String]
  #     Output only. The GCP location where the Instance resides.
  # @!attribute [rw] cmek_key_name
  #   @return [::String]
  #     Required. The Customer Managed Encryption Key (CMEK) used for data encryption.
  #     The CMEK name should follow the format of
  #     `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)`,
  #     where the `location` must match InstanceConfig.location.
  class Config
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of the Instance.
  module State
    # The default value. This value is used if the state is omitted.
    STATE_UNSPECIFIED = 0

    # The Instance has not been initialized or has been deleted.
    INACTIVE = 1

    # The Instance is being created.
    CREATING = 2

    # The Instance has been created and is ready for use.
    ACTIVE = 3

    # The Instance is being updated.
    UPDATING = 4

    # The Instance is being deleted.
    DELETING = 5

    # The Instance encountered an error during a state change.
    FAILED = 6
  end
end