Class: Google::Cloud::FinancialServices::V1::Model

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

Overview

Model represents a trained model.

Defined Under Namespace

Modules: State Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Output only. The timestamp of creation of this resource.

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'proto_docs/google/cloud/financialservices/v1/model.rb', line 66

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

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

  # The possible states of a resource.
  module State
    # State is unspecified, should not occur.
    STATE_UNSPECIFIED = 0

    # The resource has not finished being created.
    CREATING = 1

    # The resource is active/ready to be used.
    ACTIVE = 2

    # The resource is in the process of being updated.
    UPDATING = 3

    # The resource is in the process of being deleted.
    DELETING = 4
  end
end

#end_time ⇒ ::Google::Protobuf::Timestamp

Returns Required. End_time specifies the latest time from which labels are used and from which data is used to generate features for training. End_time should be no later than the end of the date_range of the dataset.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Required. End_time specifies the latest time from which labels are used and from which data is used to generate features for training. End_time should be no later than the end of the date_range of the dataset.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'proto_docs/google/cloud/financialservices/v1/model.rb', line 66

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

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

  # The possible states of a resource.
  module State
    # State is unspecified, should not occur.
    STATE_UNSPECIFIED = 0

    # The resource has not finished being created.
    CREATING = 1

    # The resource is active/ready to be used.
    ACTIVE = 2

    # The resource is in the process of being updated.
    UPDATING = 3

    # The resource is in the process of being deleted.
    DELETING = 4
  end
end

#engine_config ⇒ ::String

Returns Required. The resource name of the EngineConfig the model training will be based on. Format: /projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engineConfig}.

Returns:

  • (::String) —

    Required. The resource name of the EngineConfig the model training will be based on. Format: /projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engineConfig}



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'proto_docs/google/cloud/financialservices/v1/model.rb', line 66

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

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

  # The possible states of a resource.
  module State
    # State is unspecified, should not occur.
    STATE_UNSPECIFIED = 0

    # The resource has not finished being created.
    CREATING = 1

    # The resource is active/ready to be used.
    ACTIVE = 2

    # The resource is in the process of being updated.
    UPDATING = 3

    # The resource is in the process of being deleted.
    DELETING = 4
  end
end

#engine_version ⇒ ::String (readonly)

Returns Output only. The EngineVersion used in training this model. This is output only, and is determined from the EngineConfig used.

Returns:

  • (::String) —

    Output only. The EngineVersion used in training this model. This is output only, and is determined from the EngineConfig used.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'proto_docs/google/cloud/financialservices/v1/model.rb', line 66

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

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

  # The possible states of a resource.
  module State
    # State is unspecified, should not occur.
    STATE_UNSPECIFIED = 0

    # The resource has not finished being created.
    CREATING = 1

    # The resource is active/ready to be used.
    ACTIVE = 2

    # The resource is in the process of being updated.
    UPDATING = 3

    # The resource is in the process of being deleted.
    DELETING = 4
  end
end

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

Returns Labels.

Returns:

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

    Labels



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'proto_docs/google/cloud/financialservices/v1/model.rb', line 66

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

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

  # The possible states of a resource.
  module State
    # State is unspecified, should not occur.
    STATE_UNSPECIFIED = 0

    # The resource has not finished being created.
    CREATING = 1

    # The resource is active/ready to be used.
    ACTIVE = 2

    # The resource is in the process of being updated.
    UPDATING = 3

    # The resource is in the process of being deleted.
    DELETING = 4
  end
end

#line_of_business ⇒ ::Google::Cloud::FinancialServices::V1::LineOfBusiness (readonly)

Returns Output only. The line of business (Retail/Commercial) this model is used for. Determined by EngineConfig, cannot be set by user.

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'proto_docs/google/cloud/financialservices/v1/model.rb', line 66

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

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

  # The possible states of a resource.
  module State
    # State is unspecified, should not occur.
    STATE_UNSPECIFIED = 0

    # The resource has not finished being created.
    CREATING = 1

    # The resource is active/ready to be used.
    ACTIVE = 2

    # The resource is in the process of being updated.
    UPDATING = 3

    # The resource is in the process of being deleted.
    DELETING = 4
  end
end

#name ⇒ ::String (readonly)

Returns Output only. The resource name of the Model. format: /projects/{project_num}/locations/{location}/instances/{instance}/models/{model}.

Returns:

  • (::String) —

    Output only. The resource name of the Model. format: /projects/{project_num}/locations/{location}/instances/{instance}/models/{model}



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'proto_docs/google/cloud/financialservices/v1/model.rb', line 66

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

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

  # The possible states of a resource.
  module State
    # State is unspecified, should not occur.
    STATE_UNSPECIFIED = 0

    # The resource has not finished being created.
    CREATING = 1

    # The resource is active/ready to be used.
    ACTIVE = 2

    # The resource is in the process of being updated.
    UPDATING = 3

    # The resource is in the process of being deleted.
    DELETING = 4
  end
end

#primary_dataset ⇒ ::String

Returns Required. The resource name of the Primary Dataset used in this model training. For information about how primary and auxiliary datasets are used, refer to the engine version's documentation. Format: /projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}.

Returns:

  • (::String) —

    Required. The resource name of the Primary Dataset used in this model training. For information about how primary and auxiliary datasets are used, refer to the engine version's documentation. Format: /projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'proto_docs/google/cloud/financialservices/v1/model.rb', line 66

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

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

  # The possible states of a resource.
  module State
    # State is unspecified, should not occur.
    STATE_UNSPECIFIED = 0

    # The resource has not finished being created.
    CREATING = 1

    # The resource is active/ready to be used.
    ACTIVE = 2

    # The resource is in the process of being updated.
    UPDATING = 3

    # The resource is in the process of being deleted.
    DELETING = 4
  end
end

#state ⇒ ::Google::Cloud::FinancialServices::V1::Model::State (readonly)

Returns Output only. State of the model (creating, active, deleting, etc.).

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'proto_docs/google/cloud/financialservices/v1/model.rb', line 66

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

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

  # The possible states of a resource.
  module State
    # State is unspecified, should not occur.
    STATE_UNSPECIFIED = 0

    # The resource has not finished being created.
    CREATING = 1

    # The resource is active/ready to be used.
    ACTIVE = 2

    # The resource is in the process of being updated.
    UPDATING = 3

    # The resource is in the process of being deleted.
    DELETING = 4
  end
end

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

Returns Output only. The timestamp of the most recent update of this resource.

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'proto_docs/google/cloud/financialservices/v1/model.rb', line 66

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

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

  # The possible states of a resource.
  module State
    # State is unspecified, should not occur.
    STATE_UNSPECIFIED = 0

    # The resource has not finished being created.
    CREATING = 1

    # The resource is active/ready to be used.
    ACTIVE = 2

    # The resource is in the process of being updated.
    UPDATING = 3

    # The resource is in the process of being deleted.
    DELETING = 4
  end
end