Class: Google::Cloud::VisionAI::V1::Corpus

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

Overview

Corpus is a set of media contents for management. Within a corpus, media shares the same data schema. Search is also restricted within a single corpus.

Defined Under Namespace

Modules: Type

Instance Attribute Summary collapse

Instance Attribute Details

#default_ttl ⇒ ::Google::Protobuf::Duration

Returns Optional. The default TTL value for all assets under the corpus without a asset level user-defined TTL. For STREAM_VIDEO type corpora, this is required and the maximum allowed default_ttl is 10 years.

Returns:

  • (::Google::Protobuf::Duration) —

    Optional. The default TTL value for all assets under the corpus without a asset level user-defined TTL. For STREAM_VIDEO type corpora, this is required and the maximum allowed default_ttl is 10 years.



976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 976

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

  # Type of the asset inside the corpus.
  module Type
    # The default type, not supposed to be used. If this default type is used,
    # the corpus will be created as STREAM_VIDEO corpus.
    TYPE_UNSPECIFIED = 0

    # Asset is a live streaming video.
    STREAM_VIDEO = 1

    # Asset is an image.
    IMAGE = 2

    # Asset is a batch video.
    VIDEO_ON_DEMAND = 3
  end
end

#description ⇒ ::String

Returns Optional. Description of the corpus. Can be up to 25000 characters long.

Returns:

  • (::String) —

    Optional. Description of the corpus. Can be up to 25000 characters long.



976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 976

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

  # Type of the asset inside the corpus.
  module Type
    # The default type, not supposed to be used. If this default type is used,
    # the corpus will be created as STREAM_VIDEO corpus.
    TYPE_UNSPECIFIED = 0

    # Asset is a live streaming video.
    STREAM_VIDEO = 1

    # Asset is an image.
    IMAGE = 2

    # Asset is a batch video.
    VIDEO_ON_DEMAND = 3
  end
end

#display_name ⇒ ::String

Returns Required. The corpus name to shown in the UI. The name can be up to 32 characters long.

Returns:

  • (::String) —

    Required. The corpus name to shown in the UI. The name can be up to 32 characters long.



976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 976

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

  # Type of the asset inside the corpus.
  module Type
    # The default type, not supposed to be used. If this default type is used,
    # the corpus will be created as STREAM_VIDEO corpus.
    TYPE_UNSPECIFIED = 0

    # Asset is a live streaming video.
    STREAM_VIDEO = 1

    # Asset is an image.
    IMAGE = 2

    # Asset is a batch video.
    VIDEO_ON_DEMAND = 3
  end
end

#name ⇒ ::String

Returns Resource name of the corpus. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}.

Returns:

  • (::String) —

    Resource name of the corpus. Format: projects/{project_number}/locations/{location_id}/corpora/{corpus_id}



976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 976

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

  # Type of the asset inside the corpus.
  module Type
    # The default type, not supposed to be used. If this default type is used,
    # the corpus will be created as STREAM_VIDEO corpus.
    TYPE_UNSPECIFIED = 0

    # Asset is a live streaming video.
    STREAM_VIDEO = 1

    # Asset is an image.
    IMAGE = 2

    # Asset is a batch video.
    VIDEO_ON_DEMAND = 3
  end
end

#satisfies_pzi ⇒ ::Boolean (readonly)

Returns Output only. This boolean field is only set for projects that have Physical Zone Isolation enabled via an Org Policy constraint. It is set to true when the corpus is a valid zone isolated corpus and false if it isn't.

Returns:

  • (::Boolean) —

    Output only. This boolean field is only set for projects that have Physical Zone Isolation enabled via an Org Policy constraint. It is set to true when the corpus is a valid zone isolated corpus and false if it isn't.



976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 976

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

  # Type of the asset inside the corpus.
  module Type
    # The default type, not supposed to be used. If this default type is used,
    # the corpus will be created as STREAM_VIDEO corpus.
    TYPE_UNSPECIFIED = 0

    # Asset is a live streaming video.
    STREAM_VIDEO = 1

    # Asset is an image.
    IMAGE = 2

    # Asset is a batch video.
    VIDEO_ON_DEMAND = 3
  end
end

#satisfies_pzs ⇒ ::Boolean (readonly)

Returns Output only. This boolean field is only set for projects that have Physical Zone Separation enabled via an Org Policy constraint. It is set to true when the corpus is a valid zone separated corpus and false if it isn't.

Returns:

  • (::Boolean) —

    Output only. This boolean field is only set for projects that have Physical Zone Separation enabled via an Org Policy constraint. It is set to true when the corpus is a valid zone separated corpus and false if it isn't.



976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 976

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

  # Type of the asset inside the corpus.
  module Type
    # The default type, not supposed to be used. If this default type is used,
    # the corpus will be created as STREAM_VIDEO corpus.
    TYPE_UNSPECIFIED = 0

    # Asset is a live streaming video.
    STREAM_VIDEO = 1

    # Asset is an image.
    IMAGE = 2

    # Asset is a batch video.
    VIDEO_ON_DEMAND = 3
  end
end

#search_capability_setting ⇒ ::Google::Cloud::VisionAI::V1::SearchCapabilitySetting

Returns Default search capability setting on corpus level.

Returns:



976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 976

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

  # Type of the asset inside the corpus.
  module Type
    # The default type, not supposed to be used. If this default type is used,
    # the corpus will be created as STREAM_VIDEO corpus.
    TYPE_UNSPECIFIED = 0

    # Asset is a live streaming video.
    STREAM_VIDEO = 1

    # Asset is an image.
    IMAGE = 2

    # Asset is a batch video.
    VIDEO_ON_DEMAND = 3
  end
end

#type ⇒ ::Google::Cloud::VisionAI::V1::Corpus::Type

Returns Optional. Type of the asset inside corpus.

Returns:



976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 976

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

  # Type of the asset inside the corpus.
  module Type
    # The default type, not supposed to be used. If this default type is used,
    # the corpus will be created as STREAM_VIDEO corpus.
    TYPE_UNSPECIFIED = 0

    # Asset is a live streaming video.
    STREAM_VIDEO = 1

    # Asset is an image.
    IMAGE = 2

    # Asset is a batch video.
    VIDEO_ON_DEMAND = 3
  end
end