Class: Google::Cloud::VisionAI::V1::Instance

Inherits:

Object

Object
Google::Cloud::VisionAI::V1::Instance

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/visionai/v1/platform.rb

Overview

Message describing Instance object Next ID: 12

Defined Under Namespace

Modules: InstanceType, State Classes: InputResource, LabelsEntry, OutputResource

Instance Attribute Summary collapse

#create_time ⇒ ::Google::Protobuf::Timestamp readonly
Output only.
#description ⇒ ::String
A description for this instance.
#display_name ⇒ ::String
Required.
#input_resources ⇒ ::Array<::Google::Cloud::VisionAI::V1::Instance::InputResource>
The input resources for the current application instance.
#instance_type ⇒ ::Google::Cloud::VisionAI::V1::Instance::InstanceType
The instance type for the current instance.
#labels ⇒ ::Google::Protobuf::Map{::String => ::String}
Labels as key value pairs.
#name ⇒ ::String readonly
Output only.
#output_resources ⇒ ::Array<::Google::Cloud::VisionAI::V1::Instance::OutputResource>
All the output resources associated to one application instance.
#state ⇒ ::Google::Cloud::VisionAI::V1::Instance::State
State of the instance.
#update_time ⇒ ::Google::Protobuf::Timestamp readonly
Output only.

Instance Attribute Details

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

Returns Output only. [Output only] Create timestamp.

Returns:

(::Google::Protobuf::Timestamp) —
Output only. [Output only] Create timestamp

# File 'proto_docs/google/cloud/visionai/v1/platform.rb', line 1115

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

  # Message of input resource used in one application instance.
  # @!attribute [rw] input_resource
  #   @return [::String]
  #     The direct input resource name.
  #     If the instance type is STREAMING_PREDICTION, the input resource is in
  #     format of
  #     "projects/123/locations/us-central1/clusters/456/streams/stream-a".
  #     If the instance type is BATCH_PREDICTION from Cloud Storage input
  #     container, the input resource is in format of "gs://bucket-a".
  # @!attribute [rw] annotated_stream
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Cloud::VisionAI::V1::StreamWithAnnotation]
  #     If the input resource is VisionAI Stream, the associated annotations
  #     can be specified using annotated_stream instead.
  # @!attribute [rw] data_type
  #   @return [::Google::Cloud::VisionAI::V1::DataType]
  #     Data type for the current input resource.
  # @!attribute [rw] consumer_node
  #   @return [::String]
  #     The name of graph node who receives the input resource.
  #     For example:
  #     input_resource:
  #     visionai.googleapis.com/v1/projects/123/locations/us-central1/clusters/456/streams/input-stream-a
  #     consumer_node: stream-input
  # @!attribute [rw] input_resource_binding
  #   @return [::String]
  #     The specific input resource binding which will consume the current Input
  #     Resource, can be ignored is there is only 1 input binding.
  # @!attribute [rw] annotations
  #   @return [::Google::Cloud::VisionAI::V1::ResourceAnnotations]
  #     Contains resource annotations.
  class InputResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Message of output resource used in one application instance.
  # @!attribute [rw] output_resource
  #   @return [::String]
  #     The output resource name for the current application instance.
  # @!attribute [rw] producer_node
  #   @return [::String]
  #     The name of graph node who produces the output resource name.
  #     For example:
  #     output_resource:
  #     /projects/123/locations/us-central1/clusters/456/streams/output-application-789-stream-a-occupancy-counting
  #     producer_node: occupancy-counting
  # @!attribute [rw] output_resource_binding
  #   @return [::String]
  #     The specific output resource binding which produces the current
  #     OutputResource.
  # @!attribute [r] is_temporary
  #   @return [::Boolean]
  #     Output only. Whether the output resource is temporary which means the
  #     resource is generated during the deployment of the application. Temporary
  #     resource will be deleted during the undeployment of the application.
  # @!attribute [r] autogen
  #   @return [::Boolean]
  #     Output only. Whether the output resource is created automatically by the
  #     Vision AI App Platform.
  class OutputResource
    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

  # All the supported instance types.
  module InstanceType
    # Unspecified instance type.
    # If the instance type is not specified, the default one is
    # STREAMING_PREDICTION.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # Instance type for streaming prediction.
    STREAMING_PREDICTION = 1

    # Instance type for batch prediction.
    BATCH_PREDICTION = 2

    # Instance type for online prediction.
    ONLINE_PREDICTION = 3
  end

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

    # State CREATING.
    CREATING = 1

    # State CREATED.
    CREATED = 2

    # State DEPLOYING.
    DEPLOYING = 3

    # State DEPLOYED.
    DEPLOYED = 4

    # State UNDEPLOYING.
    UNDEPLOYING = 5

    # State DELETED.
    DELETED = 6

    # State ERROR.
    ERROR = 7

    # State Updating
    UPDATING = 8

    # State Deleting.
    DELETING = 9

    # State Fixing.
    FIXING = 10

    # State Finished.
    FINISHED = 11
  end
end

#description ⇒ `::String`

Returns A description for this instance.

Returns:

(::String) —
A description for this instance.

# File 'proto_docs/google/cloud/visionai/v1/platform.rb', line 1115

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

  # Message of input resource used in one application instance.
  # @!attribute [rw] input_resource
  #   @return [::String]
  #     The direct input resource name.
  #     If the instance type is STREAMING_PREDICTION, the input resource is in
  #     format of
  #     "projects/123/locations/us-central1/clusters/456/streams/stream-a".
  #     If the instance type is BATCH_PREDICTION from Cloud Storage input
  #     container, the input resource is in format of "gs://bucket-a".
  # @!attribute [rw] annotated_stream
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Cloud::VisionAI::V1::StreamWithAnnotation]
  #     If the input resource is VisionAI Stream, the associated annotations
  #     can be specified using annotated_stream instead.
  # @!attribute [rw] data_type
  #   @return [::Google::Cloud::VisionAI::V1::DataType]
  #     Data type for the current input resource.
  # @!attribute [rw] consumer_node
  #   @return [::String]
  #     The name of graph node who receives the input resource.
  #     For example:
  #     input_resource:
  #     visionai.googleapis.com/v1/projects/123/locations/us-central1/clusters/456/streams/input-stream-a
  #     consumer_node: stream-input
  # @!attribute [rw] input_resource_binding
  #   @return [::String]
  #     The specific input resource binding which will consume the current Input
  #     Resource, can be ignored is there is only 1 input binding.
  # @!attribute [rw] annotations
  #   @return [::Google::Cloud::VisionAI::V1::ResourceAnnotations]
  #     Contains resource annotations.
  class InputResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Message of output resource used in one application instance.
  # @!attribute [rw] output_resource
  #   @return [::String]
  #     The output resource name for the current application instance.
  # @!attribute [rw] producer_node
  #   @return [::String]
  #     The name of graph node who produces the output resource name.
  #     For example:
  #     output_resource:
  #     /projects/123/locations/us-central1/clusters/456/streams/output-application-789-stream-a-occupancy-counting
  #     producer_node: occupancy-counting
  # @!attribute [rw] output_resource_binding
  #   @return [::String]
  #     The specific output resource binding which produces the current
  #     OutputResource.
  # @!attribute [r] is_temporary
  #   @return [::Boolean]
  #     Output only. Whether the output resource is temporary which means the
  #     resource is generated during the deployment of the application. Temporary
  #     resource will be deleted during the undeployment of the application.
  # @!attribute [r] autogen
  #   @return [::Boolean]
  #     Output only. Whether the output resource is created automatically by the
  #     Vision AI App Platform.
  class OutputResource
    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

  # All the supported instance types.
  module InstanceType
    # Unspecified instance type.
    # If the instance type is not specified, the default one is
    # STREAMING_PREDICTION.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # Instance type for streaming prediction.
    STREAMING_PREDICTION = 1

    # Instance type for batch prediction.
    BATCH_PREDICTION = 2

    # Instance type for online prediction.
    ONLINE_PREDICTION = 3
  end

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

    # State CREATING.
    CREATING = 1

    # State CREATED.
    CREATED = 2

    # State DEPLOYING.
    DEPLOYING = 3

    # State DEPLOYED.
    DEPLOYED = 4

    # State UNDEPLOYING.
    UNDEPLOYING = 5

    # State DELETED.
    DELETED = 6

    # State ERROR.
    ERROR = 7

    # State Updating
    UPDATING = 8

    # State Deleting.
    DELETING = 9

    # State Fixing.
    FIXING = 10

    # State Finished.
    FINISHED = 11
  end
end

#display_name ⇒ `::String`

Returns Required. A user friendly display name for the solution.

Returns:

(::String) —
Required. A user friendly display name for the solution.

# File 'proto_docs/google/cloud/visionai/v1/platform.rb', line 1115

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

  # Message of input resource used in one application instance.
  # @!attribute [rw] input_resource
  #   @return [::String]
  #     The direct input resource name.
  #     If the instance type is STREAMING_PREDICTION, the input resource is in
  #     format of
  #     "projects/123/locations/us-central1/clusters/456/streams/stream-a".
  #     If the instance type is BATCH_PREDICTION from Cloud Storage input
  #     container, the input resource is in format of "gs://bucket-a".
  # @!attribute [rw] annotated_stream
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Cloud::VisionAI::V1::StreamWithAnnotation]
  #     If the input resource is VisionAI Stream, the associated annotations
  #     can be specified using annotated_stream instead.
  # @!attribute [rw] data_type
  #   @return [::Google::Cloud::VisionAI::V1::DataType]
  #     Data type for the current input resource.
  # @!attribute [rw] consumer_node
  #   @return [::String]
  #     The name of graph node who receives the input resource.
  #     For example:
  #     input_resource:
  #     visionai.googleapis.com/v1/projects/123/locations/us-central1/clusters/456/streams/input-stream-a
  #     consumer_node: stream-input
  # @!attribute [rw] input_resource_binding
  #   @return [::String]
  #     The specific input resource binding which will consume the current Input
  #     Resource, can be ignored is there is only 1 input binding.
  # @!attribute [rw] annotations
  #   @return [::Google::Cloud::VisionAI::V1::ResourceAnnotations]
  #     Contains resource annotations.
  class InputResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Message of output resource used in one application instance.
  # @!attribute [rw] output_resource
  #   @return [::String]
  #     The output resource name for the current application instance.
  # @!attribute [rw] producer_node
  #   @return [::String]
  #     The name of graph node who produces the output resource name.
  #     For example:
  #     output_resource:
  #     /projects/123/locations/us-central1/clusters/456/streams/output-application-789-stream-a-occupancy-counting
  #     producer_node: occupancy-counting
  # @!attribute [rw] output_resource_binding
  #   @return [::String]
  #     The specific output resource binding which produces the current
  #     OutputResource.
  # @!attribute [r] is_temporary
  #   @return [::Boolean]
  #     Output only. Whether the output resource is temporary which means the
  #     resource is generated during the deployment of the application. Temporary
  #     resource will be deleted during the undeployment of the application.
  # @!attribute [r] autogen
  #   @return [::Boolean]
  #     Output only. Whether the output resource is created automatically by the
  #     Vision AI App Platform.
  class OutputResource
    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

  # All the supported instance types.
  module InstanceType
    # Unspecified instance type.
    # If the instance type is not specified, the default one is
    # STREAMING_PREDICTION.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # Instance type for streaming prediction.
    STREAMING_PREDICTION = 1

    # Instance type for batch prediction.
    BATCH_PREDICTION = 2

    # Instance type for online prediction.
    ONLINE_PREDICTION = 3
  end

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

    # State CREATING.
    CREATING = 1

    # State CREATED.
    CREATED = 2

    # State DEPLOYING.
    DEPLOYING = 3

    # State DEPLOYED.
    DEPLOYED = 4

    # State UNDEPLOYING.
    UNDEPLOYING = 5

    # State DELETED.
    DELETED = 6

    # State ERROR.
    ERROR = 7

    # State Updating
    UPDATING = 8

    # State Deleting.
    DELETING = 9

    # State Fixing.
    FIXING = 10

    # State Finished.
    FINISHED = 11
  end
end

#input_resources ⇒ `::Array<::Google::Cloud::VisionAI::V1::Instance::InputResource>`

Returns The input resources for the current application instance. For example: input_resources: visionai.googleapis.com/v1/projects/123/locations/us-central1/clusters/456/streams/stream-a.

Returns:

(::Array<::Google::Cloud::VisionAI::V1::Instance::InputResource>) —
The input resources for the current application instance. For example: input_resources: visionai.googleapis.com/v1/projects/123/locations/us-central1/clusters/456/streams/stream-a

# File 'proto_docs/google/cloud/visionai/v1/platform.rb', line 1115

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

  # Message of input resource used in one application instance.
  # @!attribute [rw] input_resource
  #   @return [::String]
  #     The direct input resource name.
  #     If the instance type is STREAMING_PREDICTION, the input resource is in
  #     format of
  #     "projects/123/locations/us-central1/clusters/456/streams/stream-a".
  #     If the instance type is BATCH_PREDICTION from Cloud Storage input
  #     container, the input resource is in format of "gs://bucket-a".
  # @!attribute [rw] annotated_stream
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Cloud::VisionAI::V1::StreamWithAnnotation]
  #     If the input resource is VisionAI Stream, the associated annotations
  #     can be specified using annotated_stream instead.
  # @!attribute [rw] data_type
  #   @return [::Google::Cloud::VisionAI::V1::DataType]
  #     Data type for the current input resource.
  # @!attribute [rw] consumer_node
  #   @return [::String]
  #     The name of graph node who receives the input resource.
  #     For example:
  #     input_resource:
  #     visionai.googleapis.com/v1/projects/123/locations/us-central1/clusters/456/streams/input-stream-a
  #     consumer_node: stream-input
  # @!attribute [rw] input_resource_binding
  #   @return [::String]
  #     The specific input resource binding which will consume the current Input
  #     Resource, can be ignored is there is only 1 input binding.
  # @!attribute [rw] annotations
  #   @return [::Google::Cloud::VisionAI::V1::ResourceAnnotations]
  #     Contains resource annotations.
  class InputResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Message of output resource used in one application instance.
  # @!attribute [rw] output_resource
  #   @return [::String]
  #     The output resource name for the current application instance.
  # @!attribute [rw] producer_node
  #   @return [::String]
  #     The name of graph node who produces the output resource name.
  #     For example:
  #     output_resource:
  #     /projects/123/locations/us-central1/clusters/456/streams/output-application-789-stream-a-occupancy-counting
  #     producer_node: occupancy-counting
  # @!attribute [rw] output_resource_binding
  #   @return [::String]
  #     The specific output resource binding which produces the current
  #     OutputResource.
  # @!attribute [r] is_temporary
  #   @return [::Boolean]
  #     Output only. Whether the output resource is temporary which means the
  #     resource is generated during the deployment of the application. Temporary
  #     resource will be deleted during the undeployment of the application.
  # @!attribute [r] autogen
  #   @return [::Boolean]
  #     Output only. Whether the output resource is created automatically by the
  #     Vision AI App Platform.
  class OutputResource
    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

  # All the supported instance types.
  module InstanceType
    # Unspecified instance type.
    # If the instance type is not specified, the default one is
    # STREAMING_PREDICTION.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # Instance type for streaming prediction.
    STREAMING_PREDICTION = 1

    # Instance type for batch prediction.
    BATCH_PREDICTION = 2

    # Instance type for online prediction.
    ONLINE_PREDICTION = 3
  end

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

    # State CREATING.
    CREATING = 1

    # State CREATED.
    CREATED = 2

    # State DEPLOYING.
    DEPLOYING = 3

    # State DEPLOYED.
    DEPLOYED = 4

    # State UNDEPLOYING.
    UNDEPLOYING = 5

    # State DELETED.
    DELETED = 6

    # State ERROR.
    ERROR = 7

    # State Updating
    UPDATING = 8

    # State Deleting.
    DELETING = 9

    # State Fixing.
    FIXING = 10

    # State Finished.
    FINISHED = 11
  end
end

#instance_type ⇒ `::Google::Cloud::VisionAI::V1::Instance::InstanceType`

Returns The instance type for the current instance.

Returns:

(::Google::Cloud::VisionAI::V1::Instance::InstanceType) —
The instance type for the current instance.

# File 'proto_docs/google/cloud/visionai/v1/platform.rb', line 1115

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

  # Message of input resource used in one application instance.
  # @!attribute [rw] input_resource
  #   @return [::String]
  #     The direct input resource name.
  #     If the instance type is STREAMING_PREDICTION, the input resource is in
  #     format of
  #     "projects/123/locations/us-central1/clusters/456/streams/stream-a".
  #     If the instance type is BATCH_PREDICTION from Cloud Storage input
  #     container, the input resource is in format of "gs://bucket-a".
  # @!attribute [rw] annotated_stream
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Cloud::VisionAI::V1::StreamWithAnnotation]
  #     If the input resource is VisionAI Stream, the associated annotations
  #     can be specified using annotated_stream instead.
  # @!attribute [rw] data_type
  #   @return [::Google::Cloud::VisionAI::V1::DataType]
  #     Data type for the current input resource.
  # @!attribute [rw] consumer_node
  #   @return [::String]
  #     The name of graph node who receives the input resource.
  #     For example:
  #     input_resource:
  #     visionai.googleapis.com/v1/projects/123/locations/us-central1/clusters/456/streams/input-stream-a
  #     consumer_node: stream-input
  # @!attribute [rw] input_resource_binding
  #   @return [::String]
  #     The specific input resource binding which will consume the current Input
  #     Resource, can be ignored is there is only 1 input binding.
  # @!attribute [rw] annotations
  #   @return [::Google::Cloud::VisionAI::V1::ResourceAnnotations]
  #     Contains resource annotations.
  class InputResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Message of output resource used in one application instance.
  # @!attribute [rw] output_resource
  #   @return [::String]
  #     The output resource name for the current application instance.
  # @!attribute [rw] producer_node
  #   @return [::String]
  #     The name of graph node who produces the output resource name.
  #     For example:
  #     output_resource:
  #     /projects/123/locations/us-central1/clusters/456/streams/output-application-789-stream-a-occupancy-counting
  #     producer_node: occupancy-counting
  # @!attribute [rw] output_resource_binding
  #   @return [::String]
  #     The specific output resource binding which produces the current
  #     OutputResource.
  # @!attribute [r] is_temporary
  #   @return [::Boolean]
  #     Output only. Whether the output resource is temporary which means the
  #     resource is generated during the deployment of the application. Temporary
  #     resource will be deleted during the undeployment of the application.
  # @!attribute [r] autogen
  #   @return [::Boolean]
  #     Output only. Whether the output resource is created automatically by the
  #     Vision AI App Platform.
  class OutputResource
    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

  # All the supported instance types.
  module InstanceType
    # Unspecified instance type.
    # If the instance type is not specified, the default one is
    # STREAMING_PREDICTION.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # Instance type for streaming prediction.
    STREAMING_PREDICTION = 1

    # Instance type for batch prediction.
    BATCH_PREDICTION = 2

    # Instance type for online prediction.
    ONLINE_PREDICTION = 3
  end

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

    # State CREATING.
    CREATING = 1

    # State CREATED.
    CREATED = 2

    # State DEPLOYING.
    DEPLOYING = 3

    # State DEPLOYED.
    DEPLOYED = 4

    # State UNDEPLOYING.
    UNDEPLOYING = 5

    # State DELETED.
    DELETED = 6

    # State ERROR.
    ERROR = 7

    # State Updating
    UPDATING = 8

    # State Deleting.
    DELETING = 9

    # State Fixing.
    FIXING = 10

    # State Finished.
    FINISHED = 11
  end
end

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

Returns Labels as key value pairs.

Returns:

(::Google::Protobuf::Map{::String => ::String}) —
Labels as key value pairs

# File 'proto_docs/google/cloud/visionai/v1/platform.rb', line 1115

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

  # Message of input resource used in one application instance.
  # @!attribute [rw] input_resource
  #   @return [::String]
  #     The direct input resource name.
  #     If the instance type is STREAMING_PREDICTION, the input resource is in
  #     format of
  #     "projects/123/locations/us-central1/clusters/456/streams/stream-a".
  #     If the instance type is BATCH_PREDICTION from Cloud Storage input
  #     container, the input resource is in format of "gs://bucket-a".
  # @!attribute [rw] annotated_stream
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Cloud::VisionAI::V1::StreamWithAnnotation]
  #     If the input resource is VisionAI Stream, the associated annotations
  #     can be specified using annotated_stream instead.
  # @!attribute [rw] data_type
  #   @return [::Google::Cloud::VisionAI::V1::DataType]
  #     Data type for the current input resource.
  # @!attribute [rw] consumer_node
  #   @return [::String]
  #     The name of graph node who receives the input resource.
  #     For example:
  #     input_resource:
  #     visionai.googleapis.com/v1/projects/123/locations/us-central1/clusters/456/streams/input-stream-a
  #     consumer_node: stream-input
  # @!attribute [rw] input_resource_binding
  #   @return [::String]
  #     The specific input resource binding which will consume the current Input
  #     Resource, can be ignored is there is only 1 input binding.
  # @!attribute [rw] annotations
  #   @return [::Google::Cloud::VisionAI::V1::ResourceAnnotations]
  #     Contains resource annotations.
  class InputResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Message of output resource used in one application instance.
  # @!attribute [rw] output_resource
  #   @return [::String]
  #     The output resource name for the current application instance.
  # @!attribute [rw] producer_node
  #   @return [::String]
  #     The name of graph node who produces the output resource name.
  #     For example:
  #     output_resource:
  #     /projects/123/locations/us-central1/clusters/456/streams/output-application-789-stream-a-occupancy-counting
  #     producer_node: occupancy-counting
  # @!attribute [rw] output_resource_binding
  #   @return [::String]
  #     The specific output resource binding which produces the current
  #     OutputResource.
  # @!attribute [r] is_temporary
  #   @return [::Boolean]
  #     Output only. Whether the output resource is temporary which means the
  #     resource is generated during the deployment of the application. Temporary
  #     resource will be deleted during the undeployment of the application.
  # @!attribute [r] autogen
  #   @return [::Boolean]
  #     Output only. Whether the output resource is created automatically by the
  #     Vision AI App Platform.
  class OutputResource
    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

  # All the supported instance types.
  module InstanceType
    # Unspecified instance type.
    # If the instance type is not specified, the default one is
    # STREAMING_PREDICTION.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # Instance type for streaming prediction.
    STREAMING_PREDICTION = 1

    # Instance type for batch prediction.
    BATCH_PREDICTION = 2

    # Instance type for online prediction.
    ONLINE_PREDICTION = 3
  end

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

    # State CREATING.
    CREATING = 1

    # State CREATED.
    CREATED = 2

    # State DEPLOYING.
    DEPLOYING = 3

    # State DEPLOYED.
    DEPLOYED = 4

    # State UNDEPLOYING.
    UNDEPLOYING = 5

    # State DELETED.
    DELETED = 6

    # State ERROR.
    ERROR = 7

    # State Updating
    UPDATING = 8

    # State Deleting.
    DELETING = 9

    # State Fixing.
    FIXING = 10

    # State Finished.
    FINISHED = 11
  end
end

#name ⇒ `::String` (readonly)

Returns Output only. name of resource.

Returns:

(::String) —
Output only. name of resource

# File 'proto_docs/google/cloud/visionai/v1/platform.rb', line 1115

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

  # Message of input resource used in one application instance.
  # @!attribute [rw] input_resource
  #   @return [::String]
  #     The direct input resource name.
  #     If the instance type is STREAMING_PREDICTION, the input resource is in
  #     format of
  #     "projects/123/locations/us-central1/clusters/456/streams/stream-a".
  #     If the instance type is BATCH_PREDICTION from Cloud Storage input
  #     container, the input resource is in format of "gs://bucket-a".
  # @!attribute [rw] annotated_stream
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Cloud::VisionAI::V1::StreamWithAnnotation]
  #     If the input resource is VisionAI Stream, the associated annotations
  #     can be specified using annotated_stream instead.
  # @!attribute [rw] data_type
  #   @return [::Google::Cloud::VisionAI::V1::DataType]
  #     Data type for the current input resource.
  # @!attribute [rw] consumer_node
  #   @return [::String]
  #     The name of graph node who receives the input resource.
  #     For example:
  #     input_resource:
  #     visionai.googleapis.com/v1/projects/123/locations/us-central1/clusters/456/streams/input-stream-a
  #     consumer_node: stream-input
  # @!attribute [rw] input_resource_binding
  #   @return [::String]
  #     The specific input resource binding which will consume the current Input
  #     Resource, can be ignored is there is only 1 input binding.
  # @!attribute [rw] annotations
  #   @return [::Google::Cloud::VisionAI::V1::ResourceAnnotations]
  #     Contains resource annotations.
  class InputResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Message of output resource used in one application instance.
  # @!attribute [rw] output_resource
  #   @return [::String]
  #     The output resource name for the current application instance.
  # @!attribute [rw] producer_node
  #   @return [::String]
  #     The name of graph node who produces the output resource name.
  #     For example:
  #     output_resource:
  #     /projects/123/locations/us-central1/clusters/456/streams/output-application-789-stream-a-occupancy-counting
  #     producer_node: occupancy-counting
  # @!attribute [rw] output_resource_binding
  #   @return [::String]
  #     The specific output resource binding which produces the current
  #     OutputResource.
  # @!attribute [r] is_temporary
  #   @return [::Boolean]
  #     Output only. Whether the output resource is temporary which means the
  #     resource is generated during the deployment of the application. Temporary
  #     resource will be deleted during the undeployment of the application.
  # @!attribute [r] autogen
  #   @return [::Boolean]
  #     Output only. Whether the output resource is created automatically by the
  #     Vision AI App Platform.
  class OutputResource
    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

  # All the supported instance types.
  module InstanceType
    # Unspecified instance type.
    # If the instance type is not specified, the default one is
    # STREAMING_PREDICTION.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # Instance type for streaming prediction.
    STREAMING_PREDICTION = 1

    # Instance type for batch prediction.
    BATCH_PREDICTION = 2

    # Instance type for online prediction.
    ONLINE_PREDICTION = 3
  end

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

    # State CREATING.
    CREATING = 1

    # State CREATED.
    CREATED = 2

    # State DEPLOYING.
    DEPLOYING = 3

    # State DEPLOYED.
    DEPLOYED = 4

    # State UNDEPLOYING.
    UNDEPLOYING = 5

    # State DELETED.
    DELETED = 6

    # State ERROR.
    ERROR = 7

    # State Updating
    UPDATING = 8

    # State Deleting.
    DELETING = 9

    # State Fixing.
    FIXING = 10

    # State Finished.
    FINISHED = 11
  end
end

#output_resources ⇒ `::Array<::Google::Cloud::VisionAI::V1::Instance::OutputResource>`

Returns All the output resources associated to one application instance.

Returns:

(::Array<::Google::Cloud::VisionAI::V1::Instance::OutputResource>) —
All the output resources associated to one application instance.

# File 'proto_docs/google/cloud/visionai/v1/platform.rb', line 1115

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

  # Message of input resource used in one application instance.
  # @!attribute [rw] input_resource
  #   @return [::String]
  #     The direct input resource name.
  #     If the instance type is STREAMING_PREDICTION, the input resource is in
  #     format of
  #     "projects/123/locations/us-central1/clusters/456/streams/stream-a".
  #     If the instance type is BATCH_PREDICTION from Cloud Storage input
  #     container, the input resource is in format of "gs://bucket-a".
  # @!attribute [rw] annotated_stream
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Cloud::VisionAI::V1::StreamWithAnnotation]
  #     If the input resource is VisionAI Stream, the associated annotations
  #     can be specified using annotated_stream instead.
  # @!attribute [rw] data_type
  #   @return [::Google::Cloud::VisionAI::V1::DataType]
  #     Data type for the current input resource.
  # @!attribute [rw] consumer_node
  #   @return [::String]
  #     The name of graph node who receives the input resource.
  #     For example:
  #     input_resource:
  #     visionai.googleapis.com/v1/projects/123/locations/us-central1/clusters/456/streams/input-stream-a
  #     consumer_node: stream-input
  # @!attribute [rw] input_resource_binding
  #   @return [::String]
  #     The specific input resource binding which will consume the current Input
  #     Resource, can be ignored is there is only 1 input binding.
  # @!attribute [rw] annotations
  #   @return [::Google::Cloud::VisionAI::V1::ResourceAnnotations]
  #     Contains resource annotations.
  class InputResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Message of output resource used in one application instance.
  # @!attribute [rw] output_resource
  #   @return [::String]
  #     The output resource name for the current application instance.
  # @!attribute [rw] producer_node
  #   @return [::String]
  #     The name of graph node who produces the output resource name.
  #     For example:
  #     output_resource:
  #     /projects/123/locations/us-central1/clusters/456/streams/output-application-789-stream-a-occupancy-counting
  #     producer_node: occupancy-counting
  # @!attribute [rw] output_resource_binding
  #   @return [::String]
  #     The specific output resource binding which produces the current
  #     OutputResource.
  # @!attribute [r] is_temporary
  #   @return [::Boolean]
  #     Output only. Whether the output resource is temporary which means the
  #     resource is generated during the deployment of the application. Temporary
  #     resource will be deleted during the undeployment of the application.
  # @!attribute [r] autogen
  #   @return [::Boolean]
  #     Output only. Whether the output resource is created automatically by the
  #     Vision AI App Platform.
  class OutputResource
    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

  # All the supported instance types.
  module InstanceType
    # Unspecified instance type.
    # If the instance type is not specified, the default one is
    # STREAMING_PREDICTION.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # Instance type for streaming prediction.
    STREAMING_PREDICTION = 1

    # Instance type for batch prediction.
    BATCH_PREDICTION = 2

    # Instance type for online prediction.
    ONLINE_PREDICTION = 3
  end

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

    # State CREATING.
    CREATING = 1

    # State CREATED.
    CREATED = 2

    # State DEPLOYING.
    DEPLOYING = 3

    # State DEPLOYED.
    DEPLOYED = 4

    # State UNDEPLOYING.
    UNDEPLOYING = 5

    # State DELETED.
    DELETED = 6

    # State ERROR.
    ERROR = 7

    # State Updating
    UPDATING = 8

    # State Deleting.
    DELETING = 9

    # State Fixing.
    FIXING = 10

    # State Finished.
    FINISHED = 11
  end
end

#state ⇒ `::Google::Cloud::VisionAI::V1::Instance::State`

Returns State of the instance.

Returns:

(::Google::Cloud::VisionAI::V1::Instance::State) —
State of the instance.

# File 'proto_docs/google/cloud/visionai/v1/platform.rb', line 1115

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

  # Message of input resource used in one application instance.
  # @!attribute [rw] input_resource
  #   @return [::String]
  #     The direct input resource name.
  #     If the instance type is STREAMING_PREDICTION, the input resource is in
  #     format of
  #     "projects/123/locations/us-central1/clusters/456/streams/stream-a".
  #     If the instance type is BATCH_PREDICTION from Cloud Storage input
  #     container, the input resource is in format of "gs://bucket-a".
  # @!attribute [rw] annotated_stream
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Cloud::VisionAI::V1::StreamWithAnnotation]
  #     If the input resource is VisionAI Stream, the associated annotations
  #     can be specified using annotated_stream instead.
  # @!attribute [rw] data_type
  #   @return [::Google::Cloud::VisionAI::V1::DataType]
  #     Data type for the current input resource.
  # @!attribute [rw] consumer_node
  #   @return [::String]
  #     The name of graph node who receives the input resource.
  #     For example:
  #     input_resource:
  #     visionai.googleapis.com/v1/projects/123/locations/us-central1/clusters/456/streams/input-stream-a
  #     consumer_node: stream-input
  # @!attribute [rw] input_resource_binding
  #   @return [::String]
  #     The specific input resource binding which will consume the current Input
  #     Resource, can be ignored is there is only 1 input binding.
  # @!attribute [rw] annotations
  #   @return [::Google::Cloud::VisionAI::V1::ResourceAnnotations]
  #     Contains resource annotations.
  class InputResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Message of output resource used in one application instance.
  # @!attribute [rw] output_resource
  #   @return [::String]
  #     The output resource name for the current application instance.
  # @!attribute [rw] producer_node
  #   @return [::String]
  #     The name of graph node who produces the output resource name.
  #     For example:
  #     output_resource:
  #     /projects/123/locations/us-central1/clusters/456/streams/output-application-789-stream-a-occupancy-counting
  #     producer_node: occupancy-counting
  # @!attribute [rw] output_resource_binding
  #   @return [::String]
  #     The specific output resource binding which produces the current
  #     OutputResource.
  # @!attribute [r] is_temporary
  #   @return [::Boolean]
  #     Output only. Whether the output resource is temporary which means the
  #     resource is generated during the deployment of the application. Temporary
  #     resource will be deleted during the undeployment of the application.
  # @!attribute [r] autogen
  #   @return [::Boolean]
  #     Output only. Whether the output resource is created automatically by the
  #     Vision AI App Platform.
  class OutputResource
    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

  # All the supported instance types.
  module InstanceType
    # Unspecified instance type.
    # If the instance type is not specified, the default one is
    # STREAMING_PREDICTION.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # Instance type for streaming prediction.
    STREAMING_PREDICTION = 1

    # Instance type for batch prediction.
    BATCH_PREDICTION = 2

    # Instance type for online prediction.
    ONLINE_PREDICTION = 3
  end

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

    # State CREATING.
    CREATING = 1

    # State CREATED.
    CREATED = 2

    # State DEPLOYING.
    DEPLOYING = 3

    # State DEPLOYED.
    DEPLOYED = 4

    # State UNDEPLOYING.
    UNDEPLOYING = 5

    # State DELETED.
    DELETED = 6

    # State ERROR.
    ERROR = 7

    # State Updating
    UPDATING = 8

    # State Deleting.
    DELETING = 9

    # State Fixing.
    FIXING = 10

    # State Finished.
    FINISHED = 11
  end
end

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

Returns Output only. [Output only] Update timestamp.

Returns:

(::Google::Protobuf::Timestamp) —
Output only. [Output only] Update timestamp

# File 'proto_docs/google/cloud/visionai/v1/platform.rb', line 1115

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

  # Message of input resource used in one application instance.
  # @!attribute [rw] input_resource
  #   @return [::String]
  #     The direct input resource name.
  #     If the instance type is STREAMING_PREDICTION, the input resource is in
  #     format of
  #     "projects/123/locations/us-central1/clusters/456/streams/stream-a".
  #     If the instance type is BATCH_PREDICTION from Cloud Storage input
  #     container, the input resource is in format of "gs://bucket-a".
  # @!attribute [rw] annotated_stream
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Cloud::VisionAI::V1::StreamWithAnnotation]
  #     If the input resource is VisionAI Stream, the associated annotations
  #     can be specified using annotated_stream instead.
  # @!attribute [rw] data_type
  #   @return [::Google::Cloud::VisionAI::V1::DataType]
  #     Data type for the current input resource.
  # @!attribute [rw] consumer_node
  #   @return [::String]
  #     The name of graph node who receives the input resource.
  #     For example:
  #     input_resource:
  #     visionai.googleapis.com/v1/projects/123/locations/us-central1/clusters/456/streams/input-stream-a
  #     consumer_node: stream-input
  # @!attribute [rw] input_resource_binding
  #   @return [::String]
  #     The specific input resource binding which will consume the current Input
  #     Resource, can be ignored is there is only 1 input binding.
  # @!attribute [rw] annotations
  #   @return [::Google::Cloud::VisionAI::V1::ResourceAnnotations]
  #     Contains resource annotations.
  class InputResource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Message of output resource used in one application instance.
  # @!attribute [rw] output_resource
  #   @return [::String]
  #     The output resource name for the current application instance.
  # @!attribute [rw] producer_node
  #   @return [::String]
  #     The name of graph node who produces the output resource name.
  #     For example:
  #     output_resource:
  #     /projects/123/locations/us-central1/clusters/456/streams/output-application-789-stream-a-occupancy-counting
  #     producer_node: occupancy-counting
  # @!attribute [rw] output_resource_binding
  #   @return [::String]
  #     The specific output resource binding which produces the current
  #     OutputResource.
  # @!attribute [r] is_temporary
  #   @return [::Boolean]
  #     Output only. Whether the output resource is temporary which means the
  #     resource is generated during the deployment of the application. Temporary
  #     resource will be deleted during the undeployment of the application.
  # @!attribute [r] autogen
  #   @return [::Boolean]
  #     Output only. Whether the output resource is created automatically by the
  #     Vision AI App Platform.
  class OutputResource
    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

  # All the supported instance types.
  module InstanceType
    # Unspecified instance type.
    # If the instance type is not specified, the default one is
    # STREAMING_PREDICTION.
    INSTANCE_TYPE_UNSPECIFIED = 0

    # Instance type for streaming prediction.
    STREAMING_PREDICTION = 1

    # Instance type for batch prediction.
    BATCH_PREDICTION = 2

    # Instance type for online prediction.
    ONLINE_PREDICTION = 3
  end

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

    # State CREATING.
    CREATING = 1

    # State CREATED.
    CREATED = 2

    # State DEPLOYING.
    DEPLOYING = 3

    # State DEPLOYED.
    DEPLOYED = 4

    # State UNDEPLOYING.
    UNDEPLOYING = 5

    # State DELETED.
    DELETED = 6

    # State ERROR.
    ERROR = 7

    # State Updating
    UPDATING = 8

    # State Deleting.
    DELETING = 9

    # State Fixing.
    FIXING = 10

    # State Finished.
    FINISHED = 11
  end
end

Class: Google::Cloud::VisionAI::V1::Instance

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

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

#description ⇒ ::String

#display_name ⇒ ::String

#input_resources ⇒ ::Array<::Google::Cloud::VisionAI::V1::Instance::InputResource>

#instance_type ⇒ ::Google::Cloud::VisionAI::V1::Instance::InstanceType

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

#name ⇒ ::String (readonly)

#output_resources ⇒ ::Array<::Google::Cloud::VisionAI::V1::Instance::OutputResource>

#state ⇒ ::Google::Cloud::VisionAI::V1::Instance::State

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

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

#description ⇒ `::String`

#display_name ⇒ `::String`

#input_resources ⇒ `::Array<::Google::Cloud::VisionAI::V1::Instance::InputResource>`

#instance_type ⇒ `::Google::Cloud::VisionAI::V1::Instance::InstanceType`

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

#name ⇒ `::String` (readonly)

#output_resources ⇒ `::Array<::Google::Cloud::VisionAI::V1::Instance::OutputResource>`

#state ⇒ `::Google::Cloud::VisionAI::V1::Instance::State`

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