generated/google/apis/firebaserules_v1/classes.rb in google-api-client-0.43.0 vs generated/google/apis/firebaserules_v1/classes.rb in google-api-client-0.44.0

- old
+ new

@@ -24,17 +24,15 @@ # 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 ````. + # 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. @@ -51,17 +49,15 @@ @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 ````. + # 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) @@ -70,12 +66,12 @@ # Update properties of this object def update!(**args) end end - # Describes where in a file an expression is found and what it was - # evaluated to over the course of its use. + # Describes where in a file an expression is found and what it was evaluated to + # over the course of its use. class ExpressionReport include Google::Apis::Core::Hashable # Subexpressions # Corresponds to the JSON property `children` @@ -161,30 +157,28 @@ @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`. + # 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. + # 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. + # 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. @@ -227,13 +221,12 @@ # `Ruleset` name associated with the `Release` executable. # Corresponds to the JSON property `rulesetName` # @return [String] attr_accessor :ruleset_name - # Optional, indicates the freshness of the result. The response is - # guaranteed to be the latest within an interval up to the - # sync_time (inclusive). + # Optional, indicates the freshness of the result. The response is guaranteed to + # be the latest within an interval up to the sync_time (inclusive). # Corresponds to the JSON property `syncTime` # @return [String] attr_accessor :sync_time # Timestamp for the most recent `Release.update_time`. @@ -342,12 +335,12 @@ # Metadata for a Ruleset. class Metadata include Google::Apis::Core::Hashable - # Services that this ruleset has declarations for (e.g., - # "cloud.firestore"). There may be 0+ of these. + # Services that this ruleset has declarations for (e.g., "cloud.firestore"). + # There may be 0+ of these. # Corresponds to the JSON property `services` # @return [Array<String>] attr_accessor :services def initialize(**args) @@ -358,52 +351,46 @@ def update!(**args) @services = args[:services] if args.key?(:services) 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`. + # `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`. class Release include Google::Apis::Core::Hashable - # Time the release was created. - # Output only. + # Time the release was created. Output only. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_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 - # combination of three. - # In the table below, for the project name `projects/foo`, the following - # relative release paths show how flat and structured names might be chosen - # to match a desired development / deployment strategy. - # Use Case | Flat Name | Structured Name - # -------------|---------------------|---------------- - # Environments | releases/qa | releases/qa - # Apps | releases/app1_qa | releases/app1/qa - # Versions | releases/app1_v2_qa | releases/app1/v2/qa - # The delimiter between the release name path elements can be almost anything - # and it should work equally well with the release name list filter, but in - # many ways the structured paths provide a clearer picture of the - # relationship between `Release` instances. - # Format: `projects/`project_id`/releases/`release_id`` + # 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 combination of three. In the table below, for the + # project name `projects/foo`, the following relative release paths show how + # flat and structured names might be chosen to match a desired development / + # deployment strategy. Use Case | Flat Name | Structured Name -------------|----- + # ----------------|---------------- Environments | releases/qa | releases/qa + # Apps | releases/app1_qa | releases/app1/qa Versions | releases/app1_v2_qa | + # releases/app1/v2/qa The delimiter between the release name path elements can + # be almost anything and it should work equally well with the release name list + # filter, but in many ways the structured paths provide a clearer picture of the + # relationship between `Release` instances. Format: `projects/`project_id`/ + # releases/`release_id`` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must - # exist the `Release` to be created. + # Name of the `Ruleset` referred to by this `Release`. The `Ruleset` must 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. + # Time the release was updated. Output only. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time def initialize(**args) @@ -421,23 +408,21 @@ # Possible result values from the function mock invocation. class Result 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 ````. + # 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 - # The result is an actual value. The type of the value must match that - # of the type declared by the service. + # 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 def initialize(**args) @@ -454,24 +439,22 @@ # `Ruleset` is an immutable copy of `Source` with a globally unique identifier # and a creation time. class Ruleset include Google::Apis::Core::Hashable - # Time the `Ruleset` was created. - # Output only. + # Time the `Ruleset` was created. Output only. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # Metadata for a Ruleset. # Corresponds to the JSON property `metadata` # @return [Google::Apis::FirebaserulesV1::Metadata] attr_accessor :metadata - # Name of the `Ruleset`. The ruleset_id is auto generated by the service. - # Format: `projects/`project_id`/rulesets/`ruleset_id`` - # Output only. + # 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 # `Source` is one or more `File` messages comprising a logical set of rules. @@ -555,15 +538,14 @@ 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 - # the `request`, `resource`, and `function_mocks` to mock a function call to - # a service-provided function. - # The `request` object represents context present at request-time. - # The `resource` is the value of the target resource as it appears in - # persistent storage before the request is executed. + # the `request`, `resource`, and `function_mocks` to mock a function call to a + # service-provided function. The `request` object represents context present at + # request-time. 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 # Test expectation. # Corresponds to the JSON property `expectation` @@ -573,45 +555,36 @@ # Specifies what should be included in the response. # Corresponds to the JSON property `expressionReportLevel` # @return [String] attr_accessor :expression_report_level - # 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. + # 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 # Specifies whether paths (such as request.path) are encoded and how. # Corresponds to the JSON property `pathEncoding` # @return [String] attr_accessor :path_encoding - # 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: - # Request field | Type - # ---------------|----------------- - # auth.uid | `string` - # auth.token | `map<string, string>` - # headers | `map<string, string>` - # method | `string` - # params | `map<string, string>` - # path | `string` - # time | `google.protobuf.Timestamp` - # If the request value is not well-formed for the service, the request will - # be rejected as an invalid argument. + # 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: Request field | Type ---------------|----------------- auth. + # uid | `string` auth.token | `map` headers | `map` method | `string` params | ` + # map` path | `string` time | `google.protobuf.Timestamp` If the request value + # is not well-formed for the service, the request will 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. + # 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) @@ -627,20 +600,19 @@ @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. + # 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"]``` + # 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 @@ -648,41 +620,35 @@ # Corresponds to the JSON property `errorPosition` # @return [Google::Apis::FirebaserulesV1::SourcePosition] attr_accessor :error_position # The mapping from expression in the ruleset AST to the values they were - # evaluated to. Partially-nested to mirror AST structure. Note that this - # field is actually tracking expressions and not permission statements in - # contrast to the "visited_expressions" field above. Literal expressions - # are omitted. + # evaluated to. Partially-nested to mirror AST structure. Note that this field + # is actually tracking expressions and not permission statements in contrast to + # the "visited_expressions" field above. Literal expressions are omitted. # Corresponds to the JSON property `expressionReports` # @return [Array<Google::Apis::FirebaserulesV1::ExpressionReport>] attr_accessor :expression_reports - # 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`. + # 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 - # The set of visited permission expressions for a given test. This returns - # the positions and evaluation results of all visited permission - # expressions which were relevant to the test case, e.g. - # ``` - # match /path ` - # allow read if: <expr> - # ` - # ``` - # For a detailed report of the intermediate evaluation states, see the - # `expression_reports` field + # The set of visited permission expressions for a given test. This returns the + # positions and evaluation results of all visited permission expressions which + # were relevant to the test case, e.g. ``` match /path ` allow read if: ` ``` + # For a detailed report of the intermediate evaluation states, see the ` + # expression_reports` field # Corresponds to the JSON property `visitedExpressions` # @return [Array<Google::Apis::FirebaserulesV1::VisitedExpression>] attr_accessor :visited_expressions def initialize(**args) @@ -708,12 +674,12 @@ # Corresponds to the JSON property `source` # @return [Google::Apis::FirebaserulesV1::Source] attr_accessor :source # `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 + # 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. # Corresponds to the JSON property `testSuite` # @return [Google::Apis::FirebaserulesV1::TestSuite] attr_accessor :test_suite @@ -730,19 +696,18 @@ # The response for FirebaseRulesService.TestRuleset. class TestRulesetResponse include Google::Apis::Core::Hashable - # Syntactic and semantic `Source` issues of varying severity. Issues of - # `ERROR` severity will prevent tests from executing. + # 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 - # 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`. + # 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 def initialize(**args) @@ -755,12 +720,12 @@ @test_results = args[:test_results] if args.key?(:test_results) 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 + # 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`. @@ -780,11 +745,11 @@ # The request for FirebaseRulesService.UpdateReleasePatch. class UpdateReleaseRequest include Google::Apis::Core::Hashable - # `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`. + # `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`. # Corresponds to the JSON property `release` # @return [Google::Apis::FirebaserulesV1::Release] attr_accessor :release # Specifies which fields to update.