Reference documentation and code samples for the API hub V1 API class Google::Cloud::ApiHub::V1::ApiHubInstance.
An ApiHubInstance represents the instance resources of the API Hub. Currently, only one ApiHub instance is allowed for each project.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#config
def config() -> ::Google::Cloud::ApiHub::V1::ApiHubInstance::Config
Returns
- (::Google::Cloud::ApiHub::V1::ApiHubInstance::Config) — Required. Config of the ApiHub instance.
#config=
def config=(value) -> ::Google::Cloud::ApiHub::V1::ApiHubInstance::Config
Parameter
- value (::Google::Cloud::ApiHub::V1::ApiHubInstance::Config) — Required. Config of the ApiHub instance.
Returns
- (::Google::Cloud::ApiHub::V1::ApiHubInstance::Config) — Required. Config of the ApiHub instance.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Creation timestamp.
#description
def description() -> ::String
Returns
- (::String) — Optional. Description of the ApiHub instance.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — Optional. Description of the ApiHub instance.
Returns
- (::String) — Optional. Description of the ApiHub instance.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — 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
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — 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
- (::Google::Protobuf::Map{::String => ::String}) — 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
#name
def name() -> ::String
Returns
-
(::String) — Identifier. Format:
projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}
.
#name=
def name=(value) -> ::String
Parameter
-
value (::String) — Identifier. Format:
projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}
.
Returns
-
(::String) — Identifier. Format:
projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}
.
#state
def state() -> ::Google::Cloud::ApiHub::V1::ApiHubInstance::State
Returns
- (::Google::Cloud::ApiHub::V1::ApiHubInstance::State) — Output only. The current state of the ApiHub instance.
#state_message
def state_message() -> ::String
Returns
-
(::String) — Output only. Extra information about ApiHub instance state. Currently the
message would be populated when state is
FAILED
.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Last update timestamp.