Class: Gapic::Model::Service::NonstandardLroProvider

Inherits:
Object
  • Object
show all
Defined in:
lib/gapic/model/service/nonstandard_lro_provider.rb

Overview

Nonstandard (AIP-151 nonconforming) long-running operation service-level model for the services that are LRO providers (contain polling methods for long-running operations)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(service_full_name, polling_method_name, lro_object_full_name, operation_status_field, operation_name_field, operation_err_code_field, operation_err_msg_field, operation_response_fields) ⇒ NonstandardLroProvider

Returns a new instance of NonstandardLroProvider.

Parameters:

  • service_full_name (String) —

    Full grpc name of this service. E.g. google.example.LroProvider.

  • polling_method_name (String) —

    Name of the method that is used to poll for LROs. E.g. Poll

  • lro_object_full_name —

    Full grpc name of the object that is returned by the polling method. E.g. google.cloud.compute.v1.Operation

  • operation_status_field (String) —

    In the Operation message for this service, the name of the status field. The status field signals that the operation has finished. It should either contain symbols, and be set to :DONE when finished or contain a boolean and be set to true when finished.

  • operation_name_field (String, nil) —

    In the Operation message for this service, the name of the name field.

  • operation_err_code_field (String, nil) —

    In the Operation message for this service, the name of the error code field.

  • operation_err_msg_field (String, nil) —

    In the Operation message for this service, the name of the error message field.

  • operation_response_fields (Hash<String, String>) —

    The map of the fields that need to be copied from the long-running operation object that the polling method returns to the polling request. The format is name of the operation object field -> name of the polling request field (from -> to). E.g. {"foo" => "bar"} means that when constructing a polling request, the following assignment should be carried out: lro_polling_request.bar = operation_object.foo.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/gapic/model/service/nonstandard_lro_provider.rb', line 109

def initialize service_full_name,
               polling_method_name,
               lro_object_full_name,
               operation_status_field,
               operation_name_field,
               operation_err_code_field,
               operation_err_msg_field,
               operation_response_fields
  @service_full_name = service_full_name
  @polling_method_name = polling_method_name
  @lro_object_full_name = lro_object_full_name
  @operation_status_field = operation_status_field
  @operation_name_field = operation_name_field
  @operation_err_code_field = operation_err_code_field
  @operation_err_msg_field = operation_err_msg_field
  @operation_response_fields = operation_response_fields
end

Instance Attribute Details

#lro_object_full_name ⇒ String (readonly)

E.g. google.cloud.compute.v1.Operation

Returns:

  • (String) —

    Full grpc name of the object that is returned by the polling method.



59
60
61
62
63
64
65
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/gapic/model/service/nonstandard_lro_provider.rb', line 59

class NonstandardLroProvider
  attr_reader :service_full_name
  attr_reader :polling_method_name
  attr_reader :lro_object_full_name
  attr_reader :operation_status_field
  attr_reader :operation_name_field
  attr_reader :operation_err_code_field
  attr_reader :operation_err_msg_field
  attr_reader :operation_response_fields

  ##
  # @return [Boolean] Whether this is a model for a nonstandard LRO provider service
  #
  def nonstandard_lro?
    true
  end

  ##
  # @param service_full_name [String]
  #   Full grpc name of this service. E.g. `google.example.LroProvider`.
  #
  # @param polling_method_name [String]
  #   Name of the method that is used to poll for LROs. E.g. `Poll`
  #
  # @param lro_object_full_name
  #   Full grpc name of the object that is returned by the polling method.
  #   E.g. `google.cloud.compute.v1.Operation`
  #
  # @param operation_status_field [String]
  #   In the Operation message for this service, the name of the `status` field.
  #   The `status` field signals that the operation has finished. It should either contain symbols, and
  #   be set to `:DONE` when finished or contain a boolean and be set to `true` when finished.
  #
  # @param operation_name_field [String, nil]
  #   In the Operation message for this service, the name of the `name` field.
  #
  # @param operation_err_code_field [String, nil]
  #   In the Operation message for this service, the name of the `error code` field.
  #
  # @param operation_err_msg_field [String, nil]
  #   In the Operation message for this service, the name of the `error message` field.
  #
  # @param operation_response_fields [Hash<String, String>]
  #   The map of the fields that need to be copied from the
  #   long-running operation object that the polling method returns to the polling request.
  #   The format is `name of the operation object field` -> `name of the polling request field` (`from -> to`).
  #   E.g. `{"foo" => "bar"}` means that when constructing a polling request,
  #   the following assignment should be carried out:
  #   `lro_polling_request.bar = operation_object.foo`.
  #
  def initialize service_full_name,
                 polling_method_name,
                 lro_object_full_name,
                 operation_status_field,
                 operation_name_field,
                 operation_err_code_field,
                 operation_err_msg_field,
                 operation_response_fields
    @service_full_name = service_full_name
    @polling_method_name = polling_method_name
    @lro_object_full_name = lro_object_full_name
    @operation_status_field = operation_status_field
    @operation_name_field = operation_name_field
    @operation_err_code_field = operation_err_code_field
    @operation_err_msg_field = operation_err_msg_field
    @operation_response_fields = operation_response_fields
  end
end

#operation_err_code_field ⇒ String? (readonly)

Returns In the Operation message for this service, the name of the error code field.

Returns:

  • (String, nil) —

    In the Operation message for this service, the name of the error code field.



59
60
61
62
63
64
65
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/gapic/model/service/nonstandard_lro_provider.rb', line 59

class NonstandardLroProvider
  attr_reader :service_full_name
  attr_reader :polling_method_name
  attr_reader :lro_object_full_name
  attr_reader :operation_status_field
  attr_reader :operation_name_field
  attr_reader :operation_err_code_field
  attr_reader :operation_err_msg_field
  attr_reader :operation_response_fields

  ##
  # @return [Boolean] Whether this is a model for a nonstandard LRO provider service
  #
  def nonstandard_lro?
    true
  end

  ##
  # @param service_full_name [String]
  #   Full grpc name of this service. E.g. `google.example.LroProvider`.
  #
  # @param polling_method_name [String]
  #   Name of the method that is used to poll for LROs. E.g. `Poll`
  #
  # @param lro_object_full_name
  #   Full grpc name of the object that is returned by the polling method.
  #   E.g. `google.cloud.compute.v1.Operation`
  #
  # @param operation_status_field [String]
  #   In the Operation message for this service, the name of the `status` field.
  #   The `status` field signals that the operation has finished. It should either contain symbols, and
  #   be set to `:DONE` when finished or contain a boolean and be set to `true` when finished.
  #
  # @param operation_name_field [String, nil]
  #   In the Operation message for this service, the name of the `name` field.
  #
  # @param operation_err_code_field [String, nil]
  #   In the Operation message for this service, the name of the `error code` field.
  #
  # @param operation_err_msg_field [String, nil]
  #   In the Operation message for this service, the name of the `error message` field.
  #
  # @param operation_response_fields [Hash<String, String>]
  #   The map of the fields that need to be copied from the
  #   long-running operation object that the polling method returns to the polling request.
  #   The format is `name of the operation object field` -> `name of the polling request field` (`from -> to`).
  #   E.g. `{"foo" => "bar"}` means that when constructing a polling request,
  #   the following assignment should be carried out:
  #   `lro_polling_request.bar = operation_object.foo`.
  #
  def initialize service_full_name,
                 polling_method_name,
                 lro_object_full_name,
                 operation_status_field,
                 operation_name_field,
                 operation_err_code_field,
                 operation_err_msg_field,
                 operation_response_fields
    @service_full_name = service_full_name
    @polling_method_name = polling_method_name
    @lro_object_full_name = lro_object_full_name
    @operation_status_field = operation_status_field
    @operation_name_field = operation_name_field
    @operation_err_code_field = operation_err_code_field
    @operation_err_msg_field = operation_err_msg_field
    @operation_response_fields = operation_response_fields
  end
end

#operation_err_msg_field ⇒ String? (readonly)

Returns In the Operation message for this service, the name of the error message field.

Returns:

  • (String, nil) —

    In the Operation message for this service, the name of the error message field.



59
60
61
62
63
64
65
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/gapic/model/service/nonstandard_lro_provider.rb', line 59

class NonstandardLroProvider
  attr_reader :service_full_name
  attr_reader :polling_method_name
  attr_reader :lro_object_full_name
  attr_reader :operation_status_field
  attr_reader :operation_name_field
  attr_reader :operation_err_code_field
  attr_reader :operation_err_msg_field
  attr_reader :operation_response_fields

  ##
  # @return [Boolean] Whether this is a model for a nonstandard LRO provider service
  #
  def nonstandard_lro?
    true
  end

  ##
  # @param service_full_name [String]
  #   Full grpc name of this service. E.g. `google.example.LroProvider`.
  #
  # @param polling_method_name [String]
  #   Name of the method that is used to poll for LROs. E.g. `Poll`
  #
  # @param lro_object_full_name
  #   Full grpc name of the object that is returned by the polling method.
  #   E.g. `google.cloud.compute.v1.Operation`
  #
  # @param operation_status_field [String]
  #   In the Operation message for this service, the name of the `status` field.
  #   The `status` field signals that the operation has finished. It should either contain symbols, and
  #   be set to `:DONE` when finished or contain a boolean and be set to `true` when finished.
  #
  # @param operation_name_field [String, nil]
  #   In the Operation message for this service, the name of the `name` field.
  #
  # @param operation_err_code_field [String, nil]
  #   In the Operation message for this service, the name of the `error code` field.
  #
  # @param operation_err_msg_field [String, nil]
  #   In the Operation message for this service, the name of the `error message` field.
  #
  # @param operation_response_fields [Hash<String, String>]
  #   The map of the fields that need to be copied from the
  #   long-running operation object that the polling method returns to the polling request.
  #   The format is `name of the operation object field` -> `name of the polling request field` (`from -> to`).
  #   E.g. `{"foo" => "bar"}` means that when constructing a polling request,
  #   the following assignment should be carried out:
  #   `lro_polling_request.bar = operation_object.foo`.
  #
  def initialize service_full_name,
                 polling_method_name,
                 lro_object_full_name,
                 operation_status_field,
                 operation_name_field,
                 operation_err_code_field,
                 operation_err_msg_field,
                 operation_response_fields
    @service_full_name = service_full_name
    @polling_method_name = polling_method_name
    @lro_object_full_name = lro_object_full_name
    @operation_status_field = operation_status_field
    @operation_name_field = operation_name_field
    @operation_err_code_field = operation_err_code_field
    @operation_err_msg_field = operation_err_msg_field
    @operation_response_fields = operation_response_fields
  end
end

#operation_name_field ⇒ String? (readonly)

Returns In the Operation message for this service, the name of the name field.

Returns:

  • (String, nil) —

    In the Operation message for this service, the name of the name field.



59
60
61
62
63
64
65
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/gapic/model/service/nonstandard_lro_provider.rb', line 59

class NonstandardLroProvider
  attr_reader :service_full_name
  attr_reader :polling_method_name
  attr_reader :lro_object_full_name
  attr_reader :operation_status_field
  attr_reader :operation_name_field
  attr_reader :operation_err_code_field
  attr_reader :operation_err_msg_field
  attr_reader :operation_response_fields

  ##
  # @return [Boolean] Whether this is a model for a nonstandard LRO provider service
  #
  def nonstandard_lro?
    true
  end

  ##
  # @param service_full_name [String]
  #   Full grpc name of this service. E.g. `google.example.LroProvider`.
  #
  # @param polling_method_name [String]
  #   Name of the method that is used to poll for LROs. E.g. `Poll`
  #
  # @param lro_object_full_name
  #   Full grpc name of the object that is returned by the polling method.
  #   E.g. `google.cloud.compute.v1.Operation`
  #
  # @param operation_status_field [String]
  #   In the Operation message for this service, the name of the `status` field.
  #   The `status` field signals that the operation has finished. It should either contain symbols, and
  #   be set to `:DONE` when finished or contain a boolean and be set to `true` when finished.
  #
  # @param operation_name_field [String, nil]
  #   In the Operation message for this service, the name of the `name` field.
  #
  # @param operation_err_code_field [String, nil]
  #   In the Operation message for this service, the name of the `error code` field.
  #
  # @param operation_err_msg_field [String, nil]
  #   In the Operation message for this service, the name of the `error message` field.
  #
  # @param operation_response_fields [Hash<String, String>]
  #   The map of the fields that need to be copied from the
  #   long-running operation object that the polling method returns to the polling request.
  #   The format is `name of the operation object field` -> `name of the polling request field` (`from -> to`).
  #   E.g. `{"foo" => "bar"}` means that when constructing a polling request,
  #   the following assignment should be carried out:
  #   `lro_polling_request.bar = operation_object.foo`.
  #
  def initialize service_full_name,
                 polling_method_name,
                 lro_object_full_name,
                 operation_status_field,
                 operation_name_field,
                 operation_err_code_field,
                 operation_err_msg_field,
                 operation_response_fields
    @service_full_name = service_full_name
    @polling_method_name = polling_method_name
    @lro_object_full_name = lro_object_full_name
    @operation_status_field = operation_status_field
    @operation_name_field = operation_name_field
    @operation_err_code_field = operation_err_code_field
    @operation_err_msg_field = operation_err_msg_field
    @operation_response_fields = operation_response_fields
  end
end

#operation_response_fields ⇒ Hash<String, String> (readonly)

long-running operation object that the polling method returns to the polling request. The format is name of the operation object field -> name of the polling request field (from -> to). E.g. {"foo" => "bar"} means that when constructing a polling request, the following assignment should be carried out: lro_polling_request.bar = operation_object.foo.

Returns:

  • (Hash<String, String>) —

    The map of the fields that need to be copied from the



59
60
61
62
63
64
65
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/gapic/model/service/nonstandard_lro_provider.rb', line 59

class NonstandardLroProvider
  attr_reader :service_full_name
  attr_reader :polling_method_name
  attr_reader :lro_object_full_name
  attr_reader :operation_status_field
  attr_reader :operation_name_field
  attr_reader :operation_err_code_field
  attr_reader :operation_err_msg_field
  attr_reader :operation_response_fields

  ##
  # @return [Boolean] Whether this is a model for a nonstandard LRO provider service
  #
  def nonstandard_lro?
    true
  end

  ##
  # @param service_full_name [String]
  #   Full grpc name of this service. E.g. `google.example.LroProvider`.
  #
  # @param polling_method_name [String]
  #   Name of the method that is used to poll for LROs. E.g. `Poll`
  #
  # @param lro_object_full_name
  #   Full grpc name of the object that is returned by the polling method.
  #   E.g. `google.cloud.compute.v1.Operation`
  #
  # @param operation_status_field [String]
  #   In the Operation message for this service, the name of the `status` field.
  #   The `status` field signals that the operation has finished. It should either contain symbols, and
  #   be set to `:DONE` when finished or contain a boolean and be set to `true` when finished.
  #
  # @param operation_name_field [String, nil]
  #   In the Operation message for this service, the name of the `name` field.
  #
  # @param operation_err_code_field [String, nil]
  #   In the Operation message for this service, the name of the `error code` field.
  #
  # @param operation_err_msg_field [String, nil]
  #   In the Operation message for this service, the name of the `error message` field.
  #
  # @param operation_response_fields [Hash<String, String>]
  #   The map of the fields that need to be copied from the
  #   long-running operation object that the polling method returns to the polling request.
  #   The format is `name of the operation object field` -> `name of the polling request field` (`from -> to`).
  #   E.g. `{"foo" => "bar"}` means that when constructing a polling request,
  #   the following assignment should be carried out:
  #   `lro_polling_request.bar = operation_object.foo`.
  #
  def initialize service_full_name,
                 polling_method_name,
                 lro_object_full_name,
                 operation_status_field,
                 operation_name_field,
                 operation_err_code_field,
                 operation_err_msg_field,
                 operation_response_fields
    @service_full_name = service_full_name
    @polling_method_name = polling_method_name
    @lro_object_full_name = lro_object_full_name
    @operation_status_field = operation_status_field
    @operation_name_field = operation_name_field
    @operation_err_code_field = operation_err_code_field
    @operation_err_msg_field = operation_err_msg_field
    @operation_response_fields = operation_response_fields
  end
end

#operation_status_field ⇒ String (readonly)

The status field signals that the operation has finished. It should either contain symbols, and be set to :DONE when finished or contain a boolean and be set to true when finished.

Returns:

  • (String) —

    In the Operation message for this service, the name of the status field.



59
60
61
62
63
64
65
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/gapic/model/service/nonstandard_lro_provider.rb', line 59

class NonstandardLroProvider
  attr_reader :service_full_name
  attr_reader :polling_method_name
  attr_reader :lro_object_full_name
  attr_reader :operation_status_field
  attr_reader :operation_name_field
  attr_reader :operation_err_code_field
  attr_reader :operation_err_msg_field
  attr_reader :operation_response_fields

  ##
  # @return [Boolean] Whether this is a model for a nonstandard LRO provider service
  #
  def nonstandard_lro?
    true
  end

  ##
  # @param service_full_name [String]
  #   Full grpc name of this service. E.g. `google.example.LroProvider`.
  #
  # @param polling_method_name [String]
  #   Name of the method that is used to poll for LROs. E.g. `Poll`
  #
  # @param lro_object_full_name
  #   Full grpc name of the object that is returned by the polling method.
  #   E.g. `google.cloud.compute.v1.Operation`
  #
  # @param operation_status_field [String]
  #   In the Operation message for this service, the name of the `status` field.
  #   The `status` field signals that the operation has finished. It should either contain symbols, and
  #   be set to `:DONE` when finished or contain a boolean and be set to `true` when finished.
  #
  # @param operation_name_field [String, nil]
  #   In the Operation message for this service, the name of the `name` field.
  #
  # @param operation_err_code_field [String, nil]
  #   In the Operation message for this service, the name of the `error code` field.
  #
  # @param operation_err_msg_field [String, nil]
  #   In the Operation message for this service, the name of the `error message` field.
  #
  # @param operation_response_fields [Hash<String, String>]
  #   The map of the fields that need to be copied from the
  #   long-running operation object that the polling method returns to the polling request.
  #   The format is `name of the operation object field` -> `name of the polling request field` (`from -> to`).
  #   E.g. `{"foo" => "bar"}` means that when constructing a polling request,
  #   the following assignment should be carried out:
  #   `lro_polling_request.bar = operation_object.foo`.
  #
  def initialize service_full_name,
                 polling_method_name,
                 lro_object_full_name,
                 operation_status_field,
                 operation_name_field,
                 operation_err_code_field,
                 operation_err_msg_field,
                 operation_response_fields
    @service_full_name = service_full_name
    @polling_method_name = polling_method_name
    @lro_object_full_name = lro_object_full_name
    @operation_status_field = operation_status_field
    @operation_name_field = operation_name_field
    @operation_err_code_field = operation_err_code_field
    @operation_err_msg_field = operation_err_msg_field
    @operation_response_fields = operation_response_fields
  end
end

#polling_method_name ⇒ String (readonly)

Returns Name of the method that is used to poll for LROs. E.g. Poll.

Returns:

  • (String) —

    Name of the method that is used to poll for LROs. E.g. Poll



59
60
61
62
63
64
65
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/gapic/model/service/nonstandard_lro_provider.rb', line 59

class NonstandardLroProvider
  attr_reader :service_full_name
  attr_reader :polling_method_name
  attr_reader :lro_object_full_name
  attr_reader :operation_status_field
  attr_reader :operation_name_field
  attr_reader :operation_err_code_field
  attr_reader :operation_err_msg_field
  attr_reader :operation_response_fields

  ##
  # @return [Boolean] Whether this is a model for a nonstandard LRO provider service
  #
  def nonstandard_lro?
    true
  end

  ##
  # @param service_full_name [String]
  #   Full grpc name of this service. E.g. `google.example.LroProvider`.
  #
  # @param polling_method_name [String]
  #   Name of the method that is used to poll for LROs. E.g. `Poll`
  #
  # @param lro_object_full_name
  #   Full grpc name of the object that is returned by the polling method.
  #   E.g. `google.cloud.compute.v1.Operation`
  #
  # @param operation_status_field [String]
  #   In the Operation message for this service, the name of the `status` field.
  #   The `status` field signals that the operation has finished. It should either contain symbols, and
  #   be set to `:DONE` when finished or contain a boolean and be set to `true` when finished.
  #
  # @param operation_name_field [String, nil]
  #   In the Operation message for this service, the name of the `name` field.
  #
  # @param operation_err_code_field [String, nil]
  #   In the Operation message for this service, the name of the `error code` field.
  #
  # @param operation_err_msg_field [String, nil]
  #   In the Operation message for this service, the name of the `error message` field.
  #
  # @param operation_response_fields [Hash<String, String>]
  #   The map of the fields that need to be copied from the
  #   long-running operation object that the polling method returns to the polling request.
  #   The format is `name of the operation object field` -> `name of the polling request field` (`from -> to`).
  #   E.g. `{"foo" => "bar"}` means that when constructing a polling request,
  #   the following assignment should be carried out:
  #   `lro_polling_request.bar = operation_object.foo`.
  #
  def initialize service_full_name,
                 polling_method_name,
                 lro_object_full_name,
                 operation_status_field,
                 operation_name_field,
                 operation_err_code_field,
                 operation_err_msg_field,
                 operation_response_fields
    @service_full_name = service_full_name
    @polling_method_name = polling_method_name
    @lro_object_full_name = lro_object_full_name
    @operation_status_field = operation_status_field
    @operation_name_field = operation_name_field
    @operation_err_code_field = operation_err_code_field
    @operation_err_msg_field = operation_err_msg_field
    @operation_response_fields = operation_response_fields
  end
end

#service_full_name ⇒ String (readonly)

Returns Full grpc name of this service. E.g. google.example.LroProvider.

Returns:

  • (String) —

    Full grpc name of this service. E.g. google.example.LroProvider.



59
60
61
62
63
64
65
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/gapic/model/service/nonstandard_lro_provider.rb', line 59

class NonstandardLroProvider
  attr_reader :service_full_name
  attr_reader :polling_method_name
  attr_reader :lro_object_full_name
  attr_reader :operation_status_field
  attr_reader :operation_name_field
  attr_reader :operation_err_code_field
  attr_reader :operation_err_msg_field
  attr_reader :operation_response_fields

  ##
  # @return [Boolean] Whether this is a model for a nonstandard LRO provider service
  #
  def nonstandard_lro?
    true
  end

  ##
  # @param service_full_name [String]
  #   Full grpc name of this service. E.g. `google.example.LroProvider`.
  #
  # @param polling_method_name [String]
  #   Name of the method that is used to poll for LROs. E.g. `Poll`
  #
  # @param lro_object_full_name
  #   Full grpc name of the object that is returned by the polling method.
  #   E.g. `google.cloud.compute.v1.Operation`
  #
  # @param operation_status_field [String]
  #   In the Operation message for this service, the name of the `status` field.
  #   The `status` field signals that the operation has finished. It should either contain symbols, and
  #   be set to `:DONE` when finished or contain a boolean and be set to `true` when finished.
  #
  # @param operation_name_field [String, nil]
  #   In the Operation message for this service, the name of the `name` field.
  #
  # @param operation_err_code_field [String, nil]
  #   In the Operation message for this service, the name of the `error code` field.
  #
  # @param operation_err_msg_field [String, nil]
  #   In the Operation message for this service, the name of the `error message` field.
  #
  # @param operation_response_fields [Hash<String, String>]
  #   The map of the fields that need to be copied from the
  #   long-running operation object that the polling method returns to the polling request.
  #   The format is `name of the operation object field` -> `name of the polling request field` (`from -> to`).
  #   E.g. `{"foo" => "bar"}` means that when constructing a polling request,
  #   the following assignment should be carried out:
  #   `lro_polling_request.bar = operation_object.foo`.
  #
  def initialize service_full_name,
                 polling_method_name,
                 lro_object_full_name,
                 operation_status_field,
                 operation_name_field,
                 operation_err_code_field,
                 operation_err_msg_field,
                 operation_response_fields
    @service_full_name = service_full_name
    @polling_method_name = polling_method_name
    @lro_object_full_name = lro_object_full_name
    @operation_status_field = operation_status_field
    @operation_name_field = operation_name_field
    @operation_err_code_field = operation_err_code_field
    @operation_err_msg_field = operation_err_msg_field
    @operation_response_fields = operation_response_fields
  end
end

Instance Method Details

#nonstandard_lro? ⇒ Boolean

Returns Whether this is a model for a nonstandard LRO provider service.

Returns:

  • (Boolean) —

    Whether this is a model for a nonstandard LRO provider service



72
73
74
 
# File 'lib/gapic/model/service/nonstandard_lro_provider.rb', line 72

def nonstandard_lro?
  true
end