google-cloud-gaming-v1 0.1.0 → 0.3.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -28,38 +28,38 @@ module Google
28
28
  # fleets.
29
29
  class Service
30
30
 
31
- include GRPC::GenericService
31
+ include ::GRPC::GenericService
32
32
 
33
33
  self.marshal_class_method = :encode
34
34
  self.unmarshal_class_method = :decode
35
35
  self.service_name = 'google.cloud.gaming.v1.GameServerDeploymentsService'
36
36
 
37
37
  # Lists game server deployments in a given project and location.
38
- rpc :ListGameServerDeployments, Google::Cloud::Gaming::V1::ListGameServerDeploymentsRequest, Google::Cloud::Gaming::V1::ListGameServerDeploymentsResponse
38
+ rpc :ListGameServerDeployments, ::Google::Cloud::Gaming::V1::ListGameServerDeploymentsRequest, ::Google::Cloud::Gaming::V1::ListGameServerDeploymentsResponse
39
39
  # Gets details of a single game server deployment.
40
- rpc :GetGameServerDeployment, Google::Cloud::Gaming::V1::GetGameServerDeploymentRequest, Google::Cloud::Gaming::V1::GameServerDeployment
40
+ rpc :GetGameServerDeployment, ::Google::Cloud::Gaming::V1::GetGameServerDeploymentRequest, ::Google::Cloud::Gaming::V1::GameServerDeployment
41
41
  # Creates a new game server deployment in a given project and location.
42
- rpc :CreateGameServerDeployment, Google::Cloud::Gaming::V1::CreateGameServerDeploymentRequest, Google::Longrunning::Operation
42
+ rpc :CreateGameServerDeployment, ::Google::Cloud::Gaming::V1::CreateGameServerDeploymentRequest, ::Google::Longrunning::Operation
43
43
  # Deletes a single game server deployment.
44
- rpc :DeleteGameServerDeployment, Google::Cloud::Gaming::V1::DeleteGameServerDeploymentRequest, Google::Longrunning::Operation
44
+ rpc :DeleteGameServerDeployment, ::Google::Cloud::Gaming::V1::DeleteGameServerDeploymentRequest, ::Google::Longrunning::Operation
45
45
  # Patches a game server deployment.
46
- rpc :UpdateGameServerDeployment, Google::Cloud::Gaming::V1::UpdateGameServerDeploymentRequest, Google::Longrunning::Operation
46
+ rpc :UpdateGameServerDeployment, ::Google::Cloud::Gaming::V1::UpdateGameServerDeploymentRequest, ::Google::Longrunning::Operation
47
47
  # Gets details a single game server deployment rollout.
48
- rpc :GetGameServerDeploymentRollout, Google::Cloud::Gaming::V1::GetGameServerDeploymentRolloutRequest, Google::Cloud::Gaming::V1::GameServerDeploymentRollout
48
+ rpc :GetGameServerDeploymentRollout, ::Google::Cloud::Gaming::V1::GetGameServerDeploymentRolloutRequest, ::Google::Cloud::Gaming::V1::GameServerDeploymentRollout
49
49
  # Patches a single game server deployment rollout.
50
50
  # The method will not return an error if the update does not affect any
51
51
  # existing realms. For example - if the default_game_server_config is changed
52
52
  # but all existing realms use the override, that is valid. Similarly, if a
53
53
  # non existing realm is explicitly called out in game_server_config_overrides
54
54
  # field, that will also not result in an error.
55
- rpc :UpdateGameServerDeploymentRollout, Google::Cloud::Gaming::V1::UpdateGameServerDeploymentRolloutRequest, Google::Longrunning::Operation
55
+ rpc :UpdateGameServerDeploymentRollout, ::Google::Cloud::Gaming::V1::UpdateGameServerDeploymentRolloutRequest, ::Google::Longrunning::Operation
56
56
  # Previews the game server deployment rollout. This API does not mutate the
57
57
  # rollout resource.
58
- rpc :PreviewGameServerDeploymentRollout, Google::Cloud::Gaming::V1::PreviewGameServerDeploymentRolloutRequest, Google::Cloud::Gaming::V1::PreviewGameServerDeploymentRolloutResponse
58
+ rpc :PreviewGameServerDeploymentRollout, ::Google::Cloud::Gaming::V1::PreviewGameServerDeploymentRolloutRequest, ::Google::Cloud::Gaming::V1::PreviewGameServerDeploymentRolloutResponse
59
59
  # Retrieves information about the current state of the game server
60
60
  # deployment. Gathers all the Agones fleets and Agones autoscalers,
61
61
  # including fleets running an older version of the game server deployment.
62
- rpc :FetchDeploymentState, Google::Cloud::Gaming::V1::FetchDeploymentStateRequest, Google::Cloud::Gaming::V1::FetchDeploymentStateResponse
62
+ rpc :FetchDeploymentState, ::Google::Cloud::Gaming::V1::FetchDeploymentStateRequest, ::Google::Cloud::Gaming::V1::FetchDeploymentStateResponse
63
63
  end
64
64
 
65
65
  Stub = Service.rpc_stub_class
@@ -61,7 +61,7 @@ module Google
61
61
  parent_config = while namespace.any?
62
62
  parent_name = namespace.join "::"
63
63
  parent_const = const_get parent_name
64
- break parent_const.configure if parent_const&.respond_to? :configure
64
+ break parent_const.configure if parent_const.respond_to? :configure
65
65
  namespace.pop
66
66
  end
67
67
  default_config = Client::Configuration.new parent_config
@@ -69,17 +69,17 @@ module Google
69
69
  default_config.rpcs.list_realms.timeout = 60.0
70
70
  default_config.rpcs.list_realms.retry_policy = {
71
71
  initial_delay: 1.0,
72
- max_delay: 10.0,
73
- multiplier: 1.3,
74
- retry_codes: [14]
72
+ max_delay: 10.0,
73
+ multiplier: 1.3,
74
+ retry_codes: [14]
75
75
  }
76
76
 
77
77
  default_config.rpcs.get_realm.timeout = 60.0
78
78
  default_config.rpcs.get_realm.retry_policy = {
79
79
  initial_delay: 1.0,
80
- max_delay: 10.0,
81
- multiplier: 1.3,
82
- retry_codes: [14]
80
+ max_delay: 10.0,
81
+ multiplier: 1.3,
82
+ retry_codes: [14]
83
83
  }
84
84
 
85
85
  default_config.rpcs.create_realm.timeout = 60.0
@@ -91,9 +91,9 @@ module Google
91
91
  default_config.rpcs.preview_realm_update.timeout = 60.0
92
92
  default_config.rpcs.preview_realm_update.retry_policy = {
93
93
  initial_delay: 1.0,
94
- max_delay: 10.0,
95
- multiplier: 1.3,
96
- retry_codes: [14]
94
+ max_delay: 10.0,
95
+ multiplier: 1.3,
96
+ retry_codes: [14]
97
97
  }
98
98
 
99
99
  default_config
@@ -157,7 +157,13 @@ module Google
157
157
 
158
158
  # Create credentials
159
159
  credentials = @config.credentials
160
- credentials ||= Credentials.default scope: @config.scope
160
+ # Use self-signed JWT if the scope and endpoint are unchanged from default,
161
+ # but only if the default endpoint does not have a region prefix.
162
+ enable_self_signed_jwt = @config.scope == Client.configure.scope &&
163
+ @config.endpoint == Client.configure.endpoint &&
164
+ !@config.endpoint.split(".").first.include?("-")
165
+ credentials ||= Credentials.default scope: @config.scope,
166
+ enable_self_signed_jwt: enable_self_signed_jwt
161
167
  if credentials.is_a?(String) || credentials.is_a?(Hash)
162
168
  credentials = Credentials.new credentials, scope: @config.scope
163
169
  end
@@ -712,14 +718,14 @@ module Google
712
718
 
713
719
  config_attr :endpoint, "gameservices.googleapis.com", ::String
714
720
  config_attr :credentials, nil do |value|
715
- allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
721
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
716
722
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
717
723
  allowed.any? { |klass| klass === value }
718
724
  end
719
725
  config_attr :scope, nil, ::String, ::Array, nil
720
726
  config_attr :lib_name, nil, ::String, nil
721
727
  config_attr :lib_version, nil, ::String, nil
722
- config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
728
+ config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
723
729
  config_attr :interceptors, nil, ::Array, nil
724
730
  config_attr :timeout, nil, ::Numeric, nil
725
731
  config_attr :metadata, nil, ::Hash, nil
@@ -740,7 +746,7 @@ module Google
740
746
  def rpcs
741
747
  @rpcs ||= begin
742
748
  parent_rpcs = nil
743
- parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config&.respond_to?(:rpcs)
749
+ parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
744
750
  Rpcs.new parent_rpcs
745
751
  end
746
752
  end
@@ -752,7 +758,7 @@ module Google
752
758
  # Each configuration object is of type `Gapic::Config::Method` and includes
753
759
  # the following configuration fields:
754
760
  #
755
- # * `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
761
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
756
762
  # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
757
763
  # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
758
764
  # include the following keys:
@@ -796,17 +802,17 @@ module Google
796
802
 
797
803
  # @private
798
804
  def initialize parent_rpcs = nil
799
- list_realms_config = parent_rpcs&.list_realms if parent_rpcs&.respond_to? :list_realms
805
+ list_realms_config = parent_rpcs.list_realms if parent_rpcs.respond_to? :list_realms
800
806
  @list_realms = ::Gapic::Config::Method.new list_realms_config
801
- get_realm_config = parent_rpcs&.get_realm if parent_rpcs&.respond_to? :get_realm
807
+ get_realm_config = parent_rpcs.get_realm if parent_rpcs.respond_to? :get_realm
802
808
  @get_realm = ::Gapic::Config::Method.new get_realm_config
803
- create_realm_config = parent_rpcs&.create_realm if parent_rpcs&.respond_to? :create_realm
809
+ create_realm_config = parent_rpcs.create_realm if parent_rpcs.respond_to? :create_realm
804
810
  @create_realm = ::Gapic::Config::Method.new create_realm_config
805
- delete_realm_config = parent_rpcs&.delete_realm if parent_rpcs&.respond_to? :delete_realm
811
+ delete_realm_config = parent_rpcs.delete_realm if parent_rpcs.respond_to? :delete_realm
806
812
  @delete_realm = ::Gapic::Config::Method.new delete_realm_config
807
- update_realm_config = parent_rpcs&.update_realm if parent_rpcs&.respond_to? :update_realm
813
+ update_realm_config = parent_rpcs.update_realm if parent_rpcs.respond_to? :update_realm
808
814
  @update_realm = ::Gapic::Config::Method.new update_realm_config
809
- preview_realm_update_config = parent_rpcs&.preview_realm_update if parent_rpcs&.respond_to? :preview_realm_update
815
+ preview_realm_update_config = parent_rpcs.preview_realm_update if parent_rpcs.respond_to? :preview_realm_update
810
816
  @preview_realm_update = ::Gapic::Config::Method.new preview_realm_update_config
811
817
 
812
818
  yield self if block_given?
@@ -103,8 +103,13 @@ module Google
103
103
  # Lists operations that match the specified filter in the request. If the
104
104
  # server doesn't support this method, it returns `UNIMPLEMENTED`.
105
105
  #
106
- # NOTE: the `name` binding below allows API services to override the binding
107
- # to use different resource name schemes, such as `users/*/operations`.
106
+ # NOTE: the `name` binding allows API services to override the binding
107
+ # to use different resource name schemes, such as `users/*/operations`. To
108
+ # override the binding, API services can add a binding such as
109
+ # `"/v1/{name=users/*}/operations"` to their service configuration.
110
+ # For backwards compatibility, the default name includes the operations
111
+ # collection id, however overriding users must ensure the name binding
112
+ # is the parent resource, without the operations collection id.
108
113
  #
109
114
  # @overload list_operations(request, options = nil)
110
115
  # Pass arguments to `list_operations` via a request object, either of type
@@ -122,7 +127,7 @@ module Google
122
127
  # the default parameter values, pass an empty Hash as a request object (see above).
123
128
  #
124
129
  # @param name [::String]
125
- # The name of the operation collection.
130
+ # The name of the operation's parent resource.
126
131
  # @param filter [::String]
127
132
  # The standard list filter.
128
133
  # @param page_size [::Integer]
@@ -390,6 +395,79 @@ module Google
390
395
  raise ::Google::Cloud::Error.from_error(e)
391
396
  end
392
397
 
398
+ ##
399
+ # Waits for the specified long-running operation until it is done or reaches
400
+ # at most a specified timeout, returning the latest state. If the operation
401
+ # is already done, the latest state is immediately returned. If the timeout
402
+ # specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
403
+ # timeout is used. If the server does not support this method, it returns
404
+ # `google.rpc.Code.UNIMPLEMENTED`.
405
+ # Note that this method is on a best-effort basis. It may return the latest
406
+ # state before the specified timeout (including immediately), meaning even an
407
+ # immediate response is no guarantee that the operation is done.
408
+ #
409
+ # @overload wait_operation(request, options = nil)
410
+ # Pass arguments to `wait_operation` via a request object, either of type
411
+ # {::Google::Longrunning::WaitOperationRequest} or an equivalent Hash.
412
+ #
413
+ # @param request [::Google::Longrunning::WaitOperationRequest, ::Hash]
414
+ # A request object representing the call parameters. Required. To specify no
415
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
416
+ # @param options [::Gapic::CallOptions, ::Hash]
417
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
418
+ #
419
+ # @overload wait_operation(name: nil, timeout: nil)
420
+ # Pass arguments to `wait_operation` via keyword arguments. Note that at
421
+ # least one keyword argument is required. To specify no parameters, or to keep all
422
+ # the default parameter values, pass an empty Hash as a request object (see above).
423
+ #
424
+ # @param name [::String]
425
+ # The name of the operation resource to wait on.
426
+ # @param timeout [::Google::Protobuf::Duration, ::Hash]
427
+ # The maximum duration to wait before timing out. If left blank, the wait
428
+ # will be at most the time permitted by the underlying HTTP/RPC protocol.
429
+ # If RPC context deadline is also specified, the shorter one will be used.
430
+ #
431
+ # @yield [response, operation] Access the result along with the RPC operation
432
+ # @yieldparam response [::Gapic::Operation]
433
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
434
+ #
435
+ # @return [::Gapic::Operation]
436
+ #
437
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
438
+ #
439
+ def wait_operation request, options = nil
440
+ raise ::ArgumentError, "request must be provided" if request.nil?
441
+
442
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Longrunning::WaitOperationRequest
443
+
444
+ # Converts hash and nil to an options object
445
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
446
+
447
+ # Customize the options with defaults
448
+ metadata = @config.rpcs.wait_operation.metadata.to_h
449
+
450
+ # Set x-goog-api-client and x-goog-user-project headers
451
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
452
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
453
+ gapic_version: ::Google::Cloud::Gaming::V1::VERSION
454
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
455
+
456
+ options.apply_defaults timeout: @config.rpcs.wait_operation.timeout,
457
+ metadata: metadata,
458
+ retry_policy: @config.rpcs.wait_operation.retry_policy
459
+ options.apply_defaults metadata: @config.metadata,
460
+ retry_policy: @config.retry_policy
461
+
462
+ @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
463
+ response = ::Gapic::Operation.new response, @operations_client, options: options
464
+ yield response, operation if block_given?
465
+ return response
466
+ end
467
+ rescue ::GRPC::BadStatus => e
468
+ raise ::Google::Cloud::Error.from_error(e)
469
+ end
470
+
393
471
  ##
394
472
  # Configuration class for the Operations API.
395
473
  #
@@ -475,14 +553,14 @@ module Google
475
553
 
476
554
  config_attr :endpoint, "gameservices.googleapis.com", ::String
477
555
  config_attr :credentials, nil do |value|
478
- allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
556
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
479
557
  allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
480
558
  allowed.any? { |klass| klass === value }
481
559
  end
482
560
  config_attr :scope, nil, ::String, ::Array, nil
483
561
  config_attr :lib_name, nil, ::String, nil
484
562
  config_attr :lib_version, nil, ::String, nil
485
- config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
563
+ config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
486
564
  config_attr :interceptors, nil, ::Array, nil
487
565
  config_attr :timeout, nil, ::Numeric, nil
488
566
  config_attr :metadata, nil, ::Hash, nil
@@ -503,7 +581,7 @@ module Google
503
581
  def rpcs
504
582
  @rpcs ||= begin
505
583
  parent_rpcs = nil
506
- parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config&.respond_to?(:rpcs)
584
+ parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
507
585
  Rpcs.new parent_rpcs
508
586
  end
509
587
  end
@@ -515,7 +593,7 @@ module Google
515
593
  # Each configuration object is of type `Gapic::Config::Method` and includes
516
594
  # the following configuration fields:
517
595
  #
518
- # * `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
596
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
519
597
  # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
520
598
  # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
521
599
  # include the following keys:
@@ -546,17 +624,24 @@ module Google
546
624
  # @return [::Gapic::Config::Method]
547
625
  #
548
626
  attr_reader :cancel_operation
627
+ ##
628
+ # RPC-specific configuration for `wait_operation`
629
+ # @return [::Gapic::Config::Method]
630
+ #
631
+ attr_reader :wait_operation
549
632
 
550
633
  # @private
551
634
  def initialize parent_rpcs = nil
552
- list_operations_config = parent_rpcs&.list_operations if parent_rpcs&.respond_to? :list_operations
635
+ list_operations_config = parent_rpcs.list_operations if parent_rpcs.respond_to? :list_operations
553
636
  @list_operations = ::Gapic::Config::Method.new list_operations_config
554
- get_operation_config = parent_rpcs&.get_operation if parent_rpcs&.respond_to? :get_operation
637
+ get_operation_config = parent_rpcs.get_operation if parent_rpcs.respond_to? :get_operation
555
638
  @get_operation = ::Gapic::Config::Method.new get_operation_config
556
- delete_operation_config = parent_rpcs&.delete_operation if parent_rpcs&.respond_to? :delete_operation
639
+ delete_operation_config = parent_rpcs.delete_operation if parent_rpcs.respond_to? :delete_operation
557
640
  @delete_operation = ::Gapic::Config::Method.new delete_operation_config
558
- cancel_operation_config = parent_rpcs&.cancel_operation if parent_rpcs&.respond_to? :cancel_operation
641
+ cancel_operation_config = parent_rpcs.cancel_operation if parent_rpcs.respond_to? :cancel_operation
559
642
  @cancel_operation = ::Gapic::Config::Method.new cancel_operation_config
643
+ wait_operation_config = parent_rpcs.wait_operation if parent_rpcs.respond_to? :wait_operation
644
+ @wait_operation = ::Gapic::Config::Method.new wait_operation_config
560
645
 
561
646
  yield self if block_given?
562
647
  end
@@ -28,24 +28,24 @@ module Google
28
28
  # interchangeable.
29
29
  class Service
30
30
 
31
- include GRPC::GenericService
31
+ include ::GRPC::GenericService
32
32
 
33
33
  self.marshal_class_method = :encode
34
34
  self.unmarshal_class_method = :decode
35
35
  self.service_name = 'google.cloud.gaming.v1.RealmsService'
36
36
 
37
37
  # Lists realms in a given project and location.
38
- rpc :ListRealms, Google::Cloud::Gaming::V1::ListRealmsRequest, Google::Cloud::Gaming::V1::ListRealmsResponse
38
+ rpc :ListRealms, ::Google::Cloud::Gaming::V1::ListRealmsRequest, ::Google::Cloud::Gaming::V1::ListRealmsResponse
39
39
  # Gets details of a single realm.
40
- rpc :GetRealm, Google::Cloud::Gaming::V1::GetRealmRequest, Google::Cloud::Gaming::V1::Realm
40
+ rpc :GetRealm, ::Google::Cloud::Gaming::V1::GetRealmRequest, ::Google::Cloud::Gaming::V1::Realm
41
41
  # Creates a new realm in a given project and location.
42
- rpc :CreateRealm, Google::Cloud::Gaming::V1::CreateRealmRequest, Google::Longrunning::Operation
42
+ rpc :CreateRealm, ::Google::Cloud::Gaming::V1::CreateRealmRequest, ::Google::Longrunning::Operation
43
43
  # Deletes a single realm.
44
- rpc :DeleteRealm, Google::Cloud::Gaming::V1::DeleteRealmRequest, Google::Longrunning::Operation
44
+ rpc :DeleteRealm, ::Google::Cloud::Gaming::V1::DeleteRealmRequest, ::Google::Longrunning::Operation
45
45
  # Patches a single realm.
46
- rpc :UpdateRealm, Google::Cloud::Gaming::V1::UpdateRealmRequest, Google::Longrunning::Operation
46
+ rpc :UpdateRealm, ::Google::Cloud::Gaming::V1::UpdateRealmRequest, ::Google::Longrunning::Operation
47
47
  # Previews patches to a single realm.
48
- rpc :PreviewRealmUpdate, Google::Cloud::Gaming::V1::PreviewRealmUpdateRequest, Google::Cloud::Gaming::V1::PreviewRealmUpdateResponse
48
+ rpc :PreviewRealmUpdate, ::Google::Cloud::Gaming::V1::PreviewRealmUpdateRequest, ::Google::Cloud::Gaming::V1::PreviewRealmUpdateResponse
49
49
  end
50
50
 
51
51
  Stub = Service.rpc_stub_class
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Gaming
23
23
  module V1
24
- VERSION = "0.1.0"
24
+ VERSION = "0.3.1"
25
25
  end
26
26
  end
27
27
  end
@@ -54,6 +54,12 @@ module Google
54
54
  # This indicates that the field may be set once in a request to create a
55
55
  # resource, but may not be changed thereafter.
56
56
  IMMUTABLE = 5
57
+
58
+ # Denotes that a (repeated) field is an unordered list.
59
+ # This indicates that the service may provide the elements of the list
60
+ # in any arbitrary order, rather than the order the user originally
61
+ # provided. Additionally, the list's order may or may not be stable.
62
+ UNORDERED_LIST = 6
57
63
  end
58
64
  end
59
65
  end
@@ -43,12 +43,12 @@ module Google
43
43
  #
44
44
  # The ResourceDescriptor Yaml config will look like:
45
45
  #
46
- # resources:
47
- # - type: "pubsub.googleapis.com/Topic"
48
- # name_descriptor:
49
- # - pattern: "projects/\\{project}/topics/\\{topic}"
50
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
51
- # parent_name_extractor: "projects/\\{project}"
46
+ # resources:
47
+ # - type: "pubsub.googleapis.com/Topic"
48
+ # name_descriptor:
49
+ # - pattern: "projects/{project}/topics/{topic}"
50
+ # parent_type: "cloudresourcemanager.googleapis.com/Project"
51
+ # parent_name_extractor: "projects/{project}"
52
52
  #
53
53
  # Sometimes, resources have multiple patterns, typically because they can
54
54
  # live under multiple parents.
@@ -183,15 +183,24 @@ module Google
183
183
  # }
184
184
  # @!attribute [rw] plural
185
185
  # @return [::String]
186
- # The plural name used in the resource name, such as 'projects' for
187
- # the name of 'projects/\\{project}'. It is the same concept of the `plural`
188
- # field in k8s CRD spec
186
+ # The plural name used in the resource name and permission names, such as
187
+ # 'projects' for the resource name of 'projects/\\{project}' and the permission
188
+ # name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
189
+ # concept of the `plural` field in k8s CRD spec
189
190
  # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
191
+ #
192
+ # Note: The plural form is required even for singleton resources. See
193
+ # https://aip.dev/156
190
194
  # @!attribute [rw] singular
191
195
  # @return [::String]
192
196
  # The same concept of the `singular` field in k8s CRD spec
193
197
  # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
194
198
  # Such as "project" for the `resourcemanager.googleapis.com/Project` type.
199
+ # @!attribute [rw] style
200
+ # @return [::Array<::Google::Api::ResourceDescriptor::Style>]
201
+ # Style flag(s) for this resource.
202
+ # These indicate that a resource is expected to conform to a given
203
+ # style. See the specific style flags for additional information.
195
204
  class ResourceDescriptor
196
205
  include ::Google::Protobuf::MessageExts
197
206
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -211,6 +220,22 @@ module Google
211
220
  # that from being necessary once there are multiple patterns.)
212
221
  FUTURE_MULTI_PATTERN = 2
213
222
  end
223
+
224
+ # A flag representing a specific style that a resource claims to conform to.
225
+ module Style
226
+ # The unspecified value. Do not use.
227
+ STYLE_UNSPECIFIED = 0
228
+
229
+ # This resource is intended to be "declarative-friendly".
230
+ #
231
+ # Declarative-friendly resources must be more strictly consistent, and
232
+ # setting this to true communicates to tools that this resource should
233
+ # adhere to declarative-friendly expectations.
234
+ #
235
+ # Note: This is used by the API linter (linter.aip.dev) to enable
236
+ # additional checks.
237
+ DECLARATIVE_FRIENDLY = 1
238
+ end
214
239
  end
215
240
 
216
241
  # Defines a proto annotation that describes a string field that refers to
@@ -226,6 +251,17 @@ module Google
226
251
  # type: "pubsub.googleapis.com/Topic"
227
252
  # }];
228
253
  # }
254
+ #
255
+ # Occasionally, a field may reference an arbitrary resource. In this case,
256
+ # APIs use the special value * in their resource reference.
257
+ #
258
+ # Example:
259
+ #
260
+ # message GetIamPolicyRequest {
261
+ # string resource = 2 [(google.api.resource_reference) = {
262
+ # type: "*"
263
+ # }];
264
+ # }
229
265
  # @!attribute [rw] child_type
230
266
  # @return [::String]
231
267
  # The resource type of a child collection that the annotated field
@@ -234,11 +270,11 @@ module Google
234
270
  #
235
271
  # Example:
236
272
  #
237
- # message ListLogEntriesRequest {
238
- # string parent = 1 [(google.api.resource_reference) = {
239
- # child_type: "logging.googleapis.com/LogEntry"
240
- # };
241
- # }
273
+ # message ListLogEntriesRequest {
274
+ # string parent = 1 [(google.api.resource_reference) = {
275
+ # child_type: "logging.googleapis.com/LogEntry"
276
+ # };
277
+ # }
242
278
  class ResourceReference
243
279
  include ::Google::Protobuf::MessageExts
244
280
  extend ::Google::Protobuf::MessageExts::ClassMethods