Class: Google::Cloud::FinancialServices::V1::PredictionResult

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

Overview

PredictionResult is the result of using a model to create predictions.

Defined Under Namespace

Modules: State Classes: LabelsEntry, Outputs

Instance Attribute Summary collapse

Instance Attribute Details

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

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

Returns:



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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'proto_docs/google/cloud/financialservices/v1/prediction_result.rb', line 72

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

  # Outputs is a list of places where the operation will write results.
  # @!attribute [rw] prediction_destination
  #   @return [::Google::Cloud::FinancialServices::V1::BigQueryDestination]
  #     Required. The location to output the predictions.
  # @!attribute [rw] explainability_destination
  #   @return [::Google::Cloud::FinancialServices::V1::BigQueryDestination]
  #     The location to output explainability information.  If not specified
  #     no explainability data will be output.
  class Outputs
    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

  # 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

#dataset ⇒ ::String

Returns Required. The resource name of the Dataset to do predictions on Format: /projects/{project_num}/locations/{location}/instances/{instance}/dataset/{dataset_id}.

Returns:

  • (::String) —

    Required. The resource name of the Dataset to do predictions on Format: /projects/{project_num}/locations/{location}/instances/{instance}/dataset/{dataset_id}



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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'proto_docs/google/cloud/financialservices/v1/prediction_result.rb', line 72

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

  # Outputs is a list of places where the operation will write results.
  # @!attribute [rw] prediction_destination
  #   @return [::Google::Cloud::FinancialServices::V1::BigQueryDestination]
  #     Required. The location to output the predictions.
  # @!attribute [rw] explainability_destination
  #   @return [::Google::Cloud::FinancialServices::V1::BigQueryDestination]
  #     The location to output explainability information.  If not specified
  #     no explainability data will be output.
  class Outputs
    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

  # 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. Specifies the latest time from which data is used to generate features for predictions. This time should be no later than the end of the date_range of the dataset.

Returns:

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

    Required. Specifies the latest time from which data is used to generate features for predictions. This time should be no later than the end of the date_range of the dataset.



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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'proto_docs/google/cloud/financialservices/v1/prediction_result.rb', line 72

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

  # Outputs is a list of places where the operation will write results.
  # @!attribute [rw] prediction_destination
  #   @return [::Google::Cloud::FinancialServices::V1::BigQueryDestination]
  #     Required. The location to output the predictions.
  # @!attribute [rw] explainability_destination
  #   @return [::Google::Cloud::FinancialServices::V1::BigQueryDestination]
  #     The location to output explainability information.  If not specified
  #     no explainability data will be output.
  class Outputs
    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

  # 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



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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'proto_docs/google/cloud/financialservices/v1/prediction_result.rb', line 72

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

  # Outputs is a list of places where the operation will write results.
  # @!attribute [rw] prediction_destination
  #   @return [::Google::Cloud::FinancialServices::V1::BigQueryDestination]
  #     Required. The location to output the predictions.
  # @!attribute [rw] explainability_destination
  #   @return [::Google::Cloud::FinancialServices::V1::BigQueryDestination]
  #     The location to output explainability information.  If not specified
  #     no explainability data will be output.
  class Outputs
    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

  # 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 prediction is for. Determined by Model, cannot be set by user.

Returns:



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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'proto_docs/google/cloud/financialservices/v1/prediction_result.rb', line 72

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

  # Outputs is a list of places where the operation will write results.
  # @!attribute [rw] prediction_destination
  #   @return [::Google::Cloud::FinancialServices::V1::BigQueryDestination]
  #     Required. The location to output the predictions.
  # @!attribute [rw] explainability_destination
  #   @return [::Google::Cloud::FinancialServices::V1::BigQueryDestination]
  #     The location to output explainability information.  If not specified
  #     no explainability data will be output.
  class Outputs
    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

  # 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

#model ⇒ ::String

Returns Required. The resource name of the Model to use to use to make predictions Format: /projects/{project_num}/locations/{location}/instances/{instance}/models/{model}.

Returns:

  • (::String) —

    Required. The resource name of the Model to use to use to make predictions Format: /projects/{project_num}/locations/{location}/instances/{instance}/models/{model}



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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'proto_docs/google/cloud/financialservices/v1/prediction_result.rb', line 72

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

  # Outputs is a list of places where the operation will write results.
  # @!attribute [rw] prediction_destination
  #   @return [::Google::Cloud::FinancialServices::V1::BigQueryDestination]
  #     Required. The location to output the predictions.
  # @!attribute [rw] explainability_destination
  #   @return [::Google::Cloud::FinancialServices::V1::BigQueryDestination]
  #     The location to output explainability information.  If not specified
  #     no explainability data will be output.
  class Outputs
    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

  # 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 PredictionResult. format: /projects/{project_num}/locations/{location}/instances/{instance}/predictionResults/{prediction_result}.

Returns:

  • (::String) —

    Output only. The resource name of the PredictionResult. format: /projects/{project_num}/locations/{location}/instances/{instance}/predictionResults/{prediction_result}



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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'proto_docs/google/cloud/financialservices/v1/prediction_result.rb', line 72

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

  # Outputs is a list of places where the operation will write results.
  # @!attribute [rw] prediction_destination
  #   @return [::Google::Cloud::FinancialServices::V1::BigQueryDestination]
  #     Required. The location to output the predictions.
  # @!attribute [rw] explainability_destination
  #   @return [::Google::Cloud::FinancialServices::V1::BigQueryDestination]
  #     The location to output explainability information.  If not specified
  #     no explainability data will be output.
  class Outputs
    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

  # 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

#outputs ⇒ ::Google::Cloud::FinancialServices::V1::PredictionResult::Outputs

Returns Required. Where to write the output of the predictions.

Returns:



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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'proto_docs/google/cloud/financialservices/v1/prediction_result.rb', line 72

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

  # Outputs is a list of places where the operation will write results.
  # @!attribute [rw] prediction_destination
  #   @return [::Google::Cloud::FinancialServices::V1::BigQueryDestination]
  #     Required. The location to output the predictions.
  # @!attribute [rw] explainability_destination
  #   @return [::Google::Cloud::FinancialServices::V1::BigQueryDestination]
  #     The location to output explainability information.  If not specified
  #     no explainability data will be output.
  class Outputs
    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

  # 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

#prediction_periods ⇒ ::Integer

Returns The number of consecutive months to produce predictions for, ending with the last full month prior to end_time according to the dataset's timezone.

Returns:

  • (::Integer) —

    The number of consecutive months to produce predictions for, ending with the last full month prior to end_time according to the dataset's timezone.



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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'proto_docs/google/cloud/financialservices/v1/prediction_result.rb', line 72

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

  # Outputs is a list of places where the operation will write results.
  # @!attribute [rw] prediction_destination
  #   @return [::Google::Cloud::FinancialServices::V1::BigQueryDestination]
  #     Required. The location to output the predictions.
  # @!attribute [rw] explainability_destination
  #   @return [::Google::Cloud::FinancialServices::V1::BigQueryDestination]
  #     The location to output explainability information.  If not specified
  #     no explainability data will be output.
  class Outputs
    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

  # 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::PredictionResult::State (readonly)

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

Returns:



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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'proto_docs/google/cloud/financialservices/v1/prediction_result.rb', line 72

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

  # Outputs is a list of places where the operation will write results.
  # @!attribute [rw] prediction_destination
  #   @return [::Google::Cloud::FinancialServices::V1::BigQueryDestination]
  #     Required. The location to output the predictions.
  # @!attribute [rw] explainability_destination
  #   @return [::Google::Cloud::FinancialServices::V1::BigQueryDestination]
  #     The location to output explainability information.  If not specified
  #     no explainability data will be output.
  class Outputs
    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

  # 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:



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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'proto_docs/google/cloud/financialservices/v1/prediction_result.rb', line 72

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

  # Outputs is a list of places where the operation will write results.
  # @!attribute [rw] prediction_destination
  #   @return [::Google::Cloud::FinancialServices::V1::BigQueryDestination]
  #     Required. The location to output the predictions.
  # @!attribute [rw] explainability_destination
  #   @return [::Google::Cloud::FinancialServices::V1::BigQueryDestination]
  #     The location to output explainability information.  If not specified
  #     no explainability data will be output.
  class Outputs
    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

  # 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