Class: Google::Cloud::ApiHub::V1::ApiHubInstance

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

Overview

An ApiHubInstance represents the instance resources of the API Hub. Currently, only one ApiHub instance is allowed for each project.

Defined Under Namespace

Modules: State Classes: Config, LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#config ⇒ ::Google::Cloud::ApiHub::V1::ApiHubInstance::Config

Returns Required. Config of the ApiHub instance.

Returns:



1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
 
# File 'proto_docs/google/cloud/apihub/v1/common_fields.rb', line 1153

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

  # Available configurations to provision an ApiHub Instance.
  # @!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 the instance location.
  class Config
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

    # The ApiHub instance is being created.
    CREATING = 2

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

    # The ApiHub instance is being updated.
    UPDATING = 4

    # The ApiHub instance is being deleted.
    DELETING = 5

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

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

Returns Output only. Creation timestamp.

Returns:



1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
 
# File 'proto_docs/google/cloud/apihub/v1/common_fields.rb', line 1153

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

  # Available configurations to provision an ApiHub Instance.
  # @!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 the instance location.
  class Config
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

    # The ApiHub instance is being created.
    CREATING = 2

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

    # The ApiHub instance is being updated.
    UPDATING = 4

    # The ApiHub instance is being deleted.
    DELETING = 5

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

#description ⇒ ::String

Returns Optional. Description of the ApiHub instance.

Returns:

  • (::String) —

    Optional. Description of the ApiHub instance.



1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
 
# File 'proto_docs/google/cloud/apihub/v1/common_fields.rb', line 1153

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

  # Available configurations to provision an ApiHub Instance.
  # @!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 the instance location.
  class Config
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

    # The ApiHub instance is being created.
    CREATING = 2

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

    # The ApiHub instance is being updated.
    UPDATING = 4

    # The ApiHub instance is being deleted.
    DELETING = 5

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

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional. Instance labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources.

Returns:



1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
 
# File 'proto_docs/google/cloud/apihub/v1/common_fields.rb', line 1153

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

  # Available configurations to provision an ApiHub Instance.
  # @!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 the instance location.
  class Config
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

    # The ApiHub instance is being created.
    CREATING = 2

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

    # The ApiHub instance is being updated.
    UPDATING = 4

    # The ApiHub instance is being deleted.
    DELETING = 5

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

#name ⇒ ::String

Returns Identifier. Format: projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}.

Returns:

  • (::String) —

    Identifier. Format: projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}.



1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
 
# File 'proto_docs/google/cloud/apihub/v1/common_fields.rb', line 1153

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

  # Available configurations to provision an ApiHub Instance.
  # @!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 the instance location.
  class Config
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

    # The ApiHub instance is being created.
    CREATING = 2

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

    # The ApiHub instance is being updated.
    UPDATING = 4

    # The ApiHub instance is being deleted.
    DELETING = 5

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

#state ⇒ ::Google::Cloud::ApiHub::V1::ApiHubInstance::State (readonly)

Returns Output only. The current state of the ApiHub instance.

Returns:



1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
 
# File 'proto_docs/google/cloud/apihub/v1/common_fields.rb', line 1153

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

  # Available configurations to provision an ApiHub Instance.
  # @!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 the instance location.
  class Config
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

    # The ApiHub instance is being created.
    CREATING = 2

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

    # The ApiHub instance is being updated.
    UPDATING = 4

    # The ApiHub instance is being deleted.
    DELETING = 5

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

#state_message ⇒ ::String (readonly)

Returns Output only. Extra information about ApiHub instance state. Currently the message would be populated when state is FAILED.

Returns:

  • (::String) —

    Output only. Extra information about ApiHub instance state. Currently the message would be populated when state is FAILED.



1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
 
# File 'proto_docs/google/cloud/apihub/v1/common_fields.rb', line 1153

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

  # Available configurations to provision an ApiHub Instance.
  # @!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 the instance location.
  class Config
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

    # The ApiHub instance is being created.
    CREATING = 2

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

    # The ApiHub instance is being updated.
    UPDATING = 4

    # The ApiHub instance is being deleted.
    DELETING = 5

    # The ApiHub 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:



1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
 
# File 'proto_docs/google/cloud/apihub/v1/common_fields.rb', line 1153

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

  # Available configurations to provision an ApiHub Instance.
  # @!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 the instance location.
  class Config
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

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

    # The ApiHub instance is being created.
    CREATING = 2

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

    # The ApiHub instance is being updated.
    UPDATING = 4

    # The ApiHub instance is being deleted.
    DELETING = 5

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