Class: Google::Cloud::Speech::V1p1beta1::CustomClass

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/speech/v1p1beta1/resource.rb

Overview

A set of words or phrases that represents a common concept likely to appear in your audio, for example a list of passenger ship names. CustomClass items can be substituted into placeholders that you set in PhraseSet phrases.

Defined Under Namespace

Modules: State Classes: AnnotationsEntry, ClassItem

Instance Attribute Summary collapse

Instance Attribute Details

#annotations ⇒ ::Google::Protobuf::Map{::String => ::String} (readonly)

Returns Output only. Allows users to store small amounts of arbitrary data. Both the key and the value must be 63 characters or less each. At most 100 annotations. This field is not used.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Output only. Allows users to store small amounts of arbitrary data. Both the key and the value must be 63 characters or less each. At most 100 annotations. This field is not used.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/cloud/speech/v1p1beta1/resource.rb', line 85

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

  # An item of the class.
  # @!attribute [rw] value
  #   @return [::String]
  #     The class item's value.
  class ClassItem
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

  # Set of states that define the lifecycle of a CustomClass.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 2

    # This CustomClass has been deleted.
    DELETED = 4
  end
end

#custom_class_id ⇒ ::String

Returns If this custom class is a resource, the custom_class_id is the resource id of the CustomClass. Case sensitive.

Returns:

  • (::String) —

    If this custom class is a resource, the custom_class_id is the resource id of the CustomClass. Case sensitive.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/cloud/speech/v1p1beta1/resource.rb', line 85

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

  # An item of the class.
  # @!attribute [rw] value
  #   @return [::String]
  #     The class item's value.
  class ClassItem
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

  # Set of states that define the lifecycle of a CustomClass.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 2

    # This CustomClass has been deleted.
    DELETED = 4
  end
end

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

Returns Output only. The time at which this resource was requested for deletion. This field is not used.

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/cloud/speech/v1p1beta1/resource.rb', line 85

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

  # An item of the class.
  # @!attribute [rw] value
  #   @return [::String]
  #     The class item's value.
  class ClassItem
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

  # Set of states that define the lifecycle of a CustomClass.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 2

    # This CustomClass has been deleted.
    DELETED = 4
  end
end

#display_name ⇒ ::String (readonly)

Returns Output only. User-settable, human-readable name for the CustomClass. Must be 63 characters or less. This field is not used.

Returns:

  • (::String) —

    Output only. User-settable, human-readable name for the CustomClass. Must be 63 characters or less. This field is not used.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/cloud/speech/v1p1beta1/resource.rb', line 85

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

  # An item of the class.
  # @!attribute [rw] value
  #   @return [::String]
  #     The class item's value.
  class ClassItem
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

  # Set of states that define the lifecycle of a CustomClass.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 2

    # This CustomClass has been deleted.
    DELETED = 4
  end
end

#etag ⇒ ::String (readonly)

Returns Output only. This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding. This field is not used.

Returns:

  • (::String) —

    Output only. This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding. This field is not used.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/cloud/speech/v1p1beta1/resource.rb', line 85

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

  # An item of the class.
  # @!attribute [rw] value
  #   @return [::String]
  #     The class item's value.
  class ClassItem
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

  # Set of states that define the lifecycle of a CustomClass.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 2

    # This CustomClass has been deleted.
    DELETED = 4
  end
end

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

Returns Output only. The time at which this resource will be purged. This field is not used.

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/cloud/speech/v1p1beta1/resource.rb', line 85

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

  # An item of the class.
  # @!attribute [rw] value
  #   @return [::String]
  #     The class item's value.
  class ClassItem
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

  # Set of states that define the lifecycle of a CustomClass.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 2

    # This CustomClass has been deleted.
    DELETED = 4
  end
end

#items ⇒ ::Array<::Google::Cloud::Speech::V1p1beta1::CustomClass::ClassItem>

Returns A collection of class items.

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/cloud/speech/v1p1beta1/resource.rb', line 85

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

  # An item of the class.
  # @!attribute [rw] value
  #   @return [::String]
  #     The class item's value.
  class ClassItem
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

  # Set of states that define the lifecycle of a CustomClass.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 2

    # This CustomClass has been deleted.
    DELETED = 4
  end
end

#kms_key_name ⇒ ::String (readonly)

Returns Output only. The KMS key name with which the content of the ClassItem is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

Returns:

  • (::String) —

    Output only. The KMS key name with which the content of the ClassItem is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/cloud/speech/v1p1beta1/resource.rb', line 85

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

  # An item of the class.
  # @!attribute [rw] value
  #   @return [::String]
  #     The class item's value.
  class ClassItem
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

  # Set of states that define the lifecycle of a CustomClass.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 2

    # This CustomClass has been deleted.
    DELETED = 4
  end
end

#kms_key_version_name ⇒ ::String (readonly)

Returns Output only. The KMS key version name with which content of the ClassItem is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}.

Returns:

  • (::String) —

    Output only. The KMS key version name with which content of the ClassItem is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/cloud/speech/v1p1beta1/resource.rb', line 85

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

  # An item of the class.
  # @!attribute [rw] value
  #   @return [::String]
  #     The class item's value.
  class ClassItem
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

  # Set of states that define the lifecycle of a CustomClass.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 2

    # This CustomClass has been deleted.
    DELETED = 4
  end
end

#name ⇒ ::String

Returns The resource name of the custom class.

Returns:

  • (::String) —

    The resource name of the custom class.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/cloud/speech/v1p1beta1/resource.rb', line 85

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

  # An item of the class.
  # @!attribute [rw] value
  #   @return [::String]
  #     The class item's value.
  class ClassItem
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

  # Set of states that define the lifecycle of a CustomClass.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 2

    # This CustomClass has been deleted.
    DELETED = 4
  end
end

#reconciling ⇒ ::Boolean (readonly)

Returns Output only. Whether or not this CustomClass is in the process of being updated. This field is not used.

Returns:

  • (::Boolean) —

    Output only. Whether or not this CustomClass is in the process of being updated. This field is not used.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/cloud/speech/v1p1beta1/resource.rb', line 85

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

  # An item of the class.
  # @!attribute [rw] value
  #   @return [::String]
  #     The class item's value.
  class ClassItem
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

  # Set of states that define the lifecycle of a CustomClass.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 2

    # This CustomClass has been deleted.
    DELETED = 4
  end
end

#state ⇒ ::Google::Cloud::Speech::V1p1beta1::CustomClass::State (readonly)

Returns Output only. The CustomClass lifecycle state. This field is not used.

Returns:



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/cloud/speech/v1p1beta1/resource.rb', line 85

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

  # An item of the class.
  # @!attribute [rw] value
  #   @return [::String]
  #     The class item's value.
  class ClassItem
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

  # Set of states that define the lifecycle of a CustomClass.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 2

    # This CustomClass has been deleted.
    DELETED = 4
  end
end

#uid ⇒ ::String (readonly)

Returns Output only. System-assigned unique identifier for the CustomClass. This field is not used.

Returns:

  • (::String) —

    Output only. System-assigned unique identifier for the CustomClass. This field is not used.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'proto_docs/google/cloud/speech/v1p1beta1/resource.rb', line 85

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

  # An item of the class.
  # @!attribute [rw] value
  #   @return [::String]
  #     The class item's value.
  class ClassItem
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

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

  # Set of states that define the lifecycle of a CustomClass.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 2

    # This CustomClass has been deleted.
    DELETED = 4
  end
end