generated/google/apis/firebaserules_v1/classes.rb in google-api-client-0.13.2 vs generated/google/apis/firebaserules_v1/classes.rb in google-api-client-0.13.3

- old
+ new

@@ -20,10 +20,60 @@ module Google module Apis module FirebaserulesV1 + # Arg matchers for the mock function. + class Arg + include Google::Apis::Core::Hashable + + # A generic empty message that you can re-use to avoid defining duplicated + # empty messages in your APIs. A typical example is to use it as the request + # or the response type of an API method. For instance: + # service Foo ` + # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); + # ` + # The JSON representation for `Empty` is empty JSON object ````. + # Corresponds to the JSON property `anyValue` + # @return [Google::Apis::FirebaserulesV1::Empty] + attr_accessor :any_value + + # Argument exactly matches value provided. + # Corresponds to the JSON property `exactValue` + # @return [Object] + attr_accessor :exact_value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @any_value = args[:any_value] if args.key?(:any_value) + @exact_value = args[:exact_value] if args.key?(:exact_value) + end + end + + # A generic empty message that you can re-use to avoid defining duplicated + # empty messages in your APIs. A typical example is to use it as the request + # or the response type of an API method. For instance: + # service Foo ` + # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); + # ` + # The JSON representation for `Empty` is empty JSON object ````. + class Empty + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + # `File` containing source content. class File include Google::Apis::Core::Hashable # Textual Content. @@ -78,33 +128,132 @@ @args = args[:args] if args.key?(:args) @function = args[:function] if args.key?(:function) end end + # Mock function definition. + # Mocks must refer to a function declared by the target service. The type of + # the function args and result will be inferred at test time. If either the + # arg or result values are not compatible with function type declaration, the + # request will be considered invalid. + # More than one `FunctionMock` may be provided for a given function name so + # long as the `Arg` matchers are distinct. There may be only one function + # for a given overload where all `Arg` values are `Arg.any_value`. + class FunctionMock + include Google::Apis::Core::Hashable + + # The list of `Arg` values to match. The order in which the arguments are + # provided is the order in which they must appear in the function + # invocation. + # Corresponds to the JSON property `args` + # @return [Array<Google::Apis::FirebaserulesV1::Arg>] + attr_accessor :args + + # The name of the function. + # The function name must match one provided by a service declaration. + # Corresponds to the JSON property `function` + # @return [String] + attr_accessor :function + + # Possible result values from the function mock invocation. + # Corresponds to the JSON property `result` + # @return [Google::Apis::FirebaserulesV1::Result] + attr_accessor :result + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @args = args[:args] if args.key?(:args) + @function = args[:function] if args.key?(:function) + @result = args[:result] if args.key?(:result) + end + end + + # Issues include warnings, errors, and deprecation notices. + class Issue + include Google::Apis::Core::Hashable + + # Short error description. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The severity of the issue. + # Corresponds to the JSON property `severity` + # @return [String] + attr_accessor :severity + + # Position in the `Source` content including its line, column number, and an + # index of the `File` in the `Source` message. Used for debug purposes. + # Corresponds to the JSON property `sourcePosition` + # @return [Google::Apis::FirebaserulesV1::SourcePosition] + attr_accessor :source_position + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @description = args[:description] if args.key?(:description) + @severity = args[:severity] if args.key?(:severity) + @source_position = args[:source_position] if args.key?(:source_position) + end + end + # The response for FirebaseRulesService.ListReleases. class ListReleasesResponse include Google::Apis::Core::Hashable + # The pagination token to retrieve the next page of results. If the value is + # empty, no further results remain. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + # List of `Release` instances. # Corresponds to the JSON property `releases` # @return [Array<Google::Apis::FirebaserulesV1::Release>] attr_accessor :releases + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @releases = args[:releases] if args.key?(:releases) + end + end + + # The response for FirebaseRulesService.ListRulesets. + class ListRulesetsResponse + include Google::Apis::Core::Hashable + # The pagination token to retrieve the next page of results. If the value is # empty, no further results remain. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token + # List of `Ruleset` instances. + # Corresponds to the JSON property `rulesets` + # @return [Array<Google::Apis::FirebaserulesV1::Ruleset>] + attr_accessor :rulesets + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) - @releases = args[:releases] if args.key?(:releases) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @rulesets = args[:rulesets] if args.key?(:rulesets) end end # `Release` is a named reference to a `Ruleset`. Once a `Release` refers to a # `Ruleset`, rules-enabled services will be able to enforce the `Ruleset`. @@ -115,16 +264,10 @@ # Output only. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time - # Time the release was updated. - # Output only. - # Corresponds to the JSON property `updateTime` - # @return [String] - attr_accessor :update_time - # Resource name for the `Release`. # `Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2` # which affords developers a great deal of flexibility in mapping the name # to the style that best fits their existing development practices. For # example, a name could refer to an environment, an app, a version, or some @@ -150,233 +293,93 @@ # exist the `Release` to be created. # Corresponds to the JSON property `rulesetName` # @return [String] attr_accessor :ruleset_name + # Time the release was updated. + # Output only. + # Corresponds to the JSON property `updateTime` + # @return [String] + attr_accessor :update_time + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @create_time = args[:create_time] if args.key?(:create_time) - @update_time = args[:update_time] if args.key?(:update_time) @name = args[:name] if args.key?(:name) @ruleset_name = args[:ruleset_name] if args.key?(:ruleset_name) + @update_time = args[:update_time] if args.key?(:update_time) end end - # The response for FirebaseRulesService.TestRuleset. - class TestRulesetResponse + # Possible result values from the function mock invocation. + class Result include Google::Apis::Core::Hashable - # The set of test results given the test cases in the `TestSuite`. - # The results will appear in the same order as the test cases appear in the - # `TestSuite`. - # Corresponds to the JSON property `testResults` - # @return [Array<Google::Apis::FirebaserulesV1::TestResult>] - attr_accessor :test_results - - # Syntactic and semantic `Source` issues of varying severity. Issues of - # `ERROR` severity will prevent tests from executing. - # Corresponds to the JSON property `issues` - # @return [Array<Google::Apis::FirebaserulesV1::Issue>] - attr_accessor :issues - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @test_results = args[:test_results] if args.key?(:test_results) - @issues = args[:issues] if args.key?(:issues) - end - end - - # Test result message containing the state of the test as well as a - # description and source position for test failures. - class TestResult - include Google::Apis::Core::Hashable - - # Position in the `Source` content including its line, column number, and an - # index of the `File` in the `Source` message. Used for debug purposes. - # Corresponds to the JSON property `errorPosition` - # @return [Google::Apis::FirebaserulesV1::SourcePosition] - attr_accessor :error_position - - # The set of function calls made to service-defined methods. - # Function calls are included in the order in which they are encountered - # during evaluation, are provided for both mocked and unmocked functions, - # and included on the response regardless of the test `state`. - # Corresponds to the JSON property `functionCalls` - # @return [Array<Google::Apis::FirebaserulesV1::FunctionCall>] - attr_accessor :function_calls - - # State of the test. - # Corresponds to the JSON property `state` - # @return [String] - attr_accessor :state - - # Debug messages related to test execution issues encountered during - # evaluation. - # Debug messages may be related to too many or too few invocations of - # function mocks or to runtime errors that occur during evaluation. - # For example: ```Unable to read variable [name: "resource"]``` - # Corresponds to the JSON property `debugMessages` - # @return [Array<String>] - attr_accessor :debug_messages - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @error_position = args[:error_position] if args.key?(:error_position) - @function_calls = args[:function_calls] if args.key?(:function_calls) - @state = args[:state] if args.key?(:state) - @debug_messages = args[:debug_messages] if args.key?(:debug_messages) - end - end - - # The response for FirebaseRulesService.ListRulesets. - class ListRulesetsResponse - include Google::Apis::Core::Hashable - - # The pagination token to retrieve the next page of results. If the value is - # empty, no further results remain. - # Corresponds to the JSON property `nextPageToken` - # @return [String] - attr_accessor :next_page_token - - # List of `Ruleset` instances. - # Corresponds to the JSON property `rulesets` - # @return [Array<Google::Apis::FirebaserulesV1::Ruleset>] - attr_accessor :rulesets - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @next_page_token = args[:next_page_token] if args.key?(:next_page_token) - @rulesets = args[:rulesets] if args.key?(:rulesets) - end - end - - # Arg matchers for the mock function. - class Arg - include Google::Apis::Core::Hashable - - # Argument exactly matches value provided. - # Corresponds to the JSON property `exactValue` - # @return [Object] - attr_accessor :exact_value - # A generic empty message that you can re-use to avoid defining duplicated # empty messages in your APIs. A typical example is to use it as the request # or the response type of an API method. For instance: # service Foo ` # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); # ` # The JSON representation for `Empty` is empty JSON object ````. - # Corresponds to the JSON property `anyValue` + # Corresponds to the JSON property `undefined` # @return [Google::Apis::FirebaserulesV1::Empty] - attr_accessor :any_value + attr_accessor :undefined - def initialize(**args) - update!(**args) - end + # The result is an actual value. The type of the value must match that + # of the type declared by the service. + # Corresponds to the JSON property `value` + # @return [Object] + attr_accessor :value - # Update properties of this object - def update!(**args) - @exact_value = args[:exact_value] if args.key?(:exact_value) - @any_value = args[:any_value] if args.key?(:any_value) - end - end - - # `TestSuite` is a collection of `TestCase` instances that validate the logical - # correctness of a `Ruleset`. The `TestSuite` may be referenced in-line within - # a `TestRuleset` invocation or as part of a `Release` object as a pre-release - # check. - class TestSuite - include Google::Apis::Core::Hashable - - # Collection of test cases associated with the `TestSuite`. - # Corresponds to the JSON property `testCases` - # @return [Array<Google::Apis::FirebaserulesV1::TestCase>] - attr_accessor :test_cases - def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) - @test_cases = args[:test_cases] if args.key?(:test_cases) + @undefined = args[:undefined] if args.key?(:undefined) + @value = args[:value] if args.key?(:value) end end - # A generic empty message that you can re-use to avoid defining duplicated - # empty messages in your APIs. A typical example is to use it as the request - # or the response type of an API method. For instance: - # service Foo ` - # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); - # ` - # The JSON representation for `Empty` is empty JSON object ````. - class Empty + # `Ruleset` is an immutable copy of `Source` with a globally unique identifier + # and a creation time. + class Ruleset include Google::Apis::Core::Hashable - def initialize(**args) - update!(**args) - end + # Time the `Ruleset` was created. + # Output only. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time - # Update properties of this object - def update!(**args) - end - end - - # Mock function definition. - # Mocks must refer to a function declared by the target service. The type of - # the function args and result will be inferred at test time. If either the - # arg or result values are not compatible with function type declaration, the - # request will be considered invalid. - # More than one `FunctionMock` may be provided for a given function name so - # long as the `Arg` matchers are distinct. There may be only one function - # for a given overload where all `Arg` values are `Arg.any_value`. - class FunctionMock - include Google::Apis::Core::Hashable - - # The list of `Arg` values to match. The order in which the arguments are - # provided is the order in which they must appear in the function - # invocation. - # Corresponds to the JSON property `args` - # @return [Array<Google::Apis::FirebaserulesV1::Arg>] - attr_accessor :args - - # The name of the function. - # The function name must match one provided by a service declaration. - # Corresponds to the JSON property `function` + # Name of the `Ruleset`. The ruleset_id is auto generated by the service. + # Format: `projects/`project_id`/rulesets/`ruleset_id`` + # Output only. + # Corresponds to the JSON property `name` # @return [String] - attr_accessor :function + attr_accessor :name - # Possible result values from the function mock invocation. - # Corresponds to the JSON property `result` - # @return [Google::Apis::FirebaserulesV1::Result] - attr_accessor :result + # `Source` is one or more `File` messages comprising a logical set of rules. + # Corresponds to the JSON property `source` + # @return [Google::Apis::FirebaserulesV1::Source] + attr_accessor :source def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) - @args = args[:args] if args.key?(:args) - @function = args[:function] if args.key?(:function) - @result = args[:result] if args.key?(:result) + @create_time = args[:create_time] if args.key?(:create_time) + @name = args[:name] if args.key?(:name) + @source = args[:source] if args.key?(:source) end end # `Source` is one or more `File` messages comprising a logical set of rules. class Source @@ -395,71 +398,39 @@ def update!(**args) @files = args[:files] if args.key?(:files) end end - # Possible result values from the function mock invocation. - class Result - include Google::Apis::Core::Hashable - - # The result is an actual value. The type of the value must match that - # of the type declared by the service. - # Corresponds to the JSON property `value` - # @return [Object] - attr_accessor :value - - # A generic empty message that you can re-use to avoid defining duplicated - # empty messages in your APIs. A typical example is to use it as the request - # or the response type of an API method. For instance: - # service Foo ` - # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); - # ` - # The JSON representation for `Empty` is empty JSON object ````. - # Corresponds to the JSON property `undefined` - # @return [Google::Apis::FirebaserulesV1::Empty] - attr_accessor :undefined - - def initialize(**args) - update!(**args) - end - - # Update properties of this object - def update!(**args) - @value = args[:value] if args.key?(:value) - @undefined = args[:undefined] if args.key?(:undefined) - end - end - # Position in the `Source` content including its line, column number, and an # index of the `File` in the `Source` message. Used for debug purposes. class SourcePosition include Google::Apis::Core::Hashable - # Line number of the source fragment. 1-based. - # Corresponds to the JSON property `line` - # @return [Fixnum] - attr_accessor :line - # First column on the source line associated with the source fragment. # Corresponds to the JSON property `column` # @return [Fixnum] attr_accessor :column # Name of the `File`. # Corresponds to the JSON property `fileName` # @return [String] attr_accessor :file_name + # Line number of the source fragment. 1-based. + # Corresponds to the JSON property `line` + # @return [Fixnum] + attr_accessor :line + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) - @line = args[:line] if args.key?(:line) @column = args[:column] if args.key?(:column) @file_name = args[:file_name] if args.key?(:file_name) + @line = args[:line] if args.key?(:line) end end # `TestCase` messages provide the request context and an expectation as to # whether the given context will be allowed or denied. Test cases may specify @@ -469,29 +440,22 @@ # The `resource` is the value of the target resource as it appears in # persistent storage before the request is executed. class TestCase include Google::Apis::Core::Hashable - # Optional resource value as it appears in persistent storage before the - # request is fulfilled. - # The resource type depends on the `request.path` value. - # Corresponds to the JSON property `resource` - # @return [Object] - attr_accessor :resource + # Test expectation. + # Corresponds to the JSON property `expectation` + # @return [String] + attr_accessor :expectation # Optional function mocks for service-defined functions. If not set, any # service defined function is expected to return an error, which may or may # not influence the test outcome. # Corresponds to the JSON property `functionMocks` # @return [Array<Google::Apis::FirebaserulesV1::FunctionMock>] attr_accessor :function_mocks - # Test expectation. - # Corresponds to the JSON property `expectation` - # @return [String] - attr_accessor :expectation - # Request context. # The exact format of the request context is service-dependent. See the # appropriate service documentation for information about the supported # fields and types on the request. Minimally, all services support the # following fields and types: @@ -508,23 +472,76 @@ # be rejected as an invalid argument. # Corresponds to the JSON property `request` # @return [Object] attr_accessor :request + # Optional resource value as it appears in persistent storage before the + # request is fulfilled. + # The resource type depends on the `request.path` value. + # Corresponds to the JSON property `resource` + # @return [Object] + attr_accessor :resource + def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) - @resource = args[:resource] if args.key?(:resource) - @function_mocks = args[:function_mocks] if args.key?(:function_mocks) @expectation = args[:expectation] if args.key?(:expectation) + @function_mocks = args[:function_mocks] if args.key?(:function_mocks) @request = args[:request] if args.key?(:request) + @resource = args[:resource] if args.key?(:resource) end end + # Test result message containing the state of the test as well as a + # description and source position for test failures. + class TestResult + include Google::Apis::Core::Hashable + + # Debug messages related to test execution issues encountered during + # evaluation. + # Debug messages may be related to too many or too few invocations of + # function mocks or to runtime errors that occur during evaluation. + # For example: ```Unable to read variable [name: "resource"]``` + # Corresponds to the JSON property `debugMessages` + # @return [Array<String>] + attr_accessor :debug_messages + + # Position in the `Source` content including its line, column number, and an + # index of the `File` in the `Source` message. Used for debug purposes. + # Corresponds to the JSON property `errorPosition` + # @return [Google::Apis::FirebaserulesV1::SourcePosition] + attr_accessor :error_position + + # The set of function calls made to service-defined methods. + # Function calls are included in the order in which they are encountered + # during evaluation, are provided for both mocked and unmocked functions, + # and included on the response regardless of the test `state`. + # Corresponds to the JSON property `functionCalls` + # @return [Array<Google::Apis::FirebaserulesV1::FunctionCall>] + attr_accessor :function_calls + + # State of the test. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @debug_messages = args[:debug_messages] if args.key?(:debug_messages) + @error_position = args[:error_position] if args.key?(:error_position) + @function_calls = args[:function_calls] if args.key?(:function_calls) + @state = args[:state] if args.key?(:state) + end + end + # The request for FirebaseRulesService.TestRuleset. class TestRulesetRequest include Google::Apis::Core::Hashable # `Source` is one or more `File` messages comprising a logical set of rules. @@ -549,73 +566,56 @@ @source = args[:source] if args.key?(:source) @test_suite = args[:test_suite] if args.key?(:test_suite) end end - # `Ruleset` is an immutable copy of `Source` with a globally unique identifier - # and a creation time. - class Ruleset + # The response for FirebaseRulesService.TestRuleset. + class TestRulesetResponse include Google::Apis::Core::Hashable - # Name of the `Ruleset`. The ruleset_id is auto generated by the service. - # Format: `projects/`project_id`/rulesets/`ruleset_id`` - # Output only. - # Corresponds to the JSON property `name` - # @return [String] - attr_accessor :name + # Syntactic and semantic `Source` issues of varying severity. Issues of + # `ERROR` severity will prevent tests from executing. + # Corresponds to the JSON property `issues` + # @return [Array<Google::Apis::FirebaserulesV1::Issue>] + attr_accessor :issues - # `Source` is one or more `File` messages comprising a logical set of rules. - # Corresponds to the JSON property `source` - # @return [Google::Apis::FirebaserulesV1::Source] - attr_accessor :source + # The set of test results given the test cases in the `TestSuite`. + # The results will appear in the same order as the test cases appear in the + # `TestSuite`. + # Corresponds to the JSON property `testResults` + # @return [Array<Google::Apis::FirebaserulesV1::TestResult>] + attr_accessor :test_results - # Time the `Ruleset` was created. - # Output only. - # Corresponds to the JSON property `createTime` - # @return [String] - attr_accessor :create_time - def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) - @name = args[:name] if args.key?(:name) - @source = args[:source] if args.key?(:source) - @create_time = args[:create_time] if args.key?(:create_time) + @issues = args[:issues] if args.key?(:issues) + @test_results = args[:test_results] if args.key?(:test_results) end end - # Issues include warnings, errors, and deprecation notices. - class Issue + # `TestSuite` is a collection of `TestCase` instances that validate the logical + # correctness of a `Ruleset`. The `TestSuite` may be referenced in-line within + # a `TestRuleset` invocation or as part of a `Release` object as a pre-release + # check. + class TestSuite include Google::Apis::Core::Hashable - # Short error description. - # Corresponds to the JSON property `description` - # @return [String] - attr_accessor :description + # Collection of test cases associated with the `TestSuite`. + # Corresponds to the JSON property `testCases` + # @return [Array<Google::Apis::FirebaserulesV1::TestCase>] + attr_accessor :test_cases - # Position in the `Source` content including its line, column number, and an - # index of the `File` in the `Source` message. Used for debug purposes. - # Corresponds to the JSON property `sourcePosition` - # @return [Google::Apis::FirebaserulesV1::SourcePosition] - attr_accessor :source_position - - # The severity of the issue. - # Corresponds to the JSON property `severity` - # @return [String] - attr_accessor :severity - def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) - @description = args[:description] if args.key?(:description) - @source_position = args[:source_position] if args.key?(:source_position) - @severity = args[:severity] if args.key?(:severity) + @test_cases = args[:test_cases] if args.key?(:test_cases) end end end end end