Class: Gapic::Model::Method::NonStandardLro

Inherits:
Object
  • Object
show all
Defined in:
lib/gapic/model/method/lro.rb

Overview

Nonstandard (AIP-151 nonconforming) long-running operation method-level model

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(method, service_full_name) ⇒ NonStandardLro

Returns a new instance of NonStandardLro.

Parameters:

  • method (Gapic::Schema::Method)
  • service_full_name (String) —

    Full grpc name of the provider service for this method's LRO



49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/gapic/model/method/lro.rb', line 49

def initialize method, service_full_name
  @service_full_name = service_full_name

  # optionally, there might be things to copy from this method's input object
  # to the LRO service's input object (`operation_request_field` annotation)
  ops_request_fields = method.input.fields.find_all do |f|
    !f.operation_request_field.nil? && !f.operation_request_field.empty?
  end

  @operation_request_fields = ops_request_fields.map do |field|
    [field.name, field.operation_request_field]
  end.to_h
end

Instance Attribute Details

#operation_request_fields ⇒ Map<String, String> (readonly)

Returns:

  • (Map<String, String>) 


40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/gapic/model/method/lro.rb', line 40

class NonStandardLro
  # @return [String]
  attr_reader :service_full_name
  # @return [Map<String, String>]
  attr_reader :operation_request_fields

  ##
  # @param method [Gapic::Schema::Method]
  # @param service_full_name [String] Full grpc name of the provider service for this method's LRO
  def initialize method, service_full_name
    @service_full_name = service_full_name

    # optionally, there might be things to copy from this method's input object
    # to the LRO service's input object (`operation_request_field` annotation)
    ops_request_fields = method.input.fields.find_all do |f|
      !f.operation_request_field.nil? && !f.operation_request_field.empty?
    end

    @operation_request_fields = ops_request_fields.map do |field|
      [field.name, field.operation_request_field]
    end.to_h
  end

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

  ##
  # @return [Boolean] Whether this is a model for the AIP-151 LRO
  #
  def aip_lro?
    false
  end
end

#service_full_name ⇒ String (readonly)

Returns:

  • (String) 


40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/gapic/model/method/lro.rb', line 40

class NonStandardLro
  # @return [String]
  attr_reader :service_full_name
  # @return [Map<String, String>]
  attr_reader :operation_request_fields

  ##
  # @param method [Gapic::Schema::Method]
  # @param service_full_name [String] Full grpc name of the provider service for this method's LRO
  def initialize method, service_full_name
    @service_full_name = service_full_name

    # optionally, there might be things to copy from this method's input object
    # to the LRO service's input object (`operation_request_field` annotation)
    ops_request_fields = method.input.fields.find_all do |f|
      !f.operation_request_field.nil? && !f.operation_request_field.empty?
    end

    @operation_request_fields = ops_request_fields.map do |field|
      [field.name, field.operation_request_field]
    end.to_h
  end

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

  ##
  # @return [Boolean] Whether this is a model for the AIP-151 LRO
  #
  def aip_lro?
    false
  end
end

Instance Method Details

#aip_lro? ⇒ Boolean

Returns Whether this is a model for the AIP-151 LRO.

Returns:

  • (Boolean) —

    Whether this is a model for the AIP-151 LRO



73
74
75
 
# File 'lib/gapic/model/method/lro.rb', line 73

def aip_lro?
  false
end

#nonstandard_lro? ⇒ Boolean

Returns Whether this is a model for the nonstandard LRO.

Returns:

  • (Boolean) —

    Whether this is a model for the nonstandard LRO



66
67
68
 
# File 'lib/gapic/model/method/lro.rb', line 66

def nonstandard_lro?
  true
end