google-apis-cloudbilling_v1 0.40.0 → 0.41.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -515,6 +515,68 @@ module Google
515
515
  execute_or_queue_command(command, &block)
516
516
  end
517
517
 
518
+ # Send a message to the agent. This is a blocking call that will return the task
519
+ # once it is completed, or a LRO if requested.
520
+ # @param [Google::Apis::CloudbillingV1::SendMessageRequest] send_message_request_object
521
+ # @param [String] fields
522
+ # Selector specifying which fields to include in a partial response.
523
+ # @param [String] quota_user
524
+ # Available to use for quota purposes for server-side applications. Can be any
525
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
526
+ # @param [Google::Apis::RequestOptions] options
527
+ # Request-specific options
528
+ #
529
+ # @yield [result, err] Result & error if block supplied
530
+ # @yieldparam result [Google::Apis::CloudbillingV1::SendMessageResponse] parsed result object
531
+ # @yieldparam err [StandardError] error object if request failed
532
+ #
533
+ # @return [Google::Apis::CloudbillingV1::SendMessageResponse]
534
+ #
535
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
536
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
537
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
538
+ def send_message(send_message_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
539
+ command = make_simple_command(:post, 'v1/message:send', options)
540
+ command.request_representation = Google::Apis::CloudbillingV1::SendMessageRequest::Representation
541
+ command.request_object = send_message_request_object
542
+ command.response_representation = Google::Apis::CloudbillingV1::SendMessageResponse::Representation
543
+ command.response_class = Google::Apis::CloudbillingV1::SendMessageResponse
544
+ command.query['fields'] = fields unless fields.nil?
545
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
546
+ execute_or_queue_command(command, &block)
547
+ end
548
+
549
+ # SendStreamingMessage is a streaming call that will return a stream of task
550
+ # update events until the Task is in an interrupted or terminal state.
551
+ # @param [Google::Apis::CloudbillingV1::SendMessageRequest] send_message_request_object
552
+ # @param [String] fields
553
+ # Selector specifying which fields to include in a partial response.
554
+ # @param [String] quota_user
555
+ # Available to use for quota purposes for server-side applications. Can be any
556
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
557
+ # @param [Google::Apis::RequestOptions] options
558
+ # Request-specific options
559
+ #
560
+ # @yield [result, err] Result & error if block supplied
561
+ # @yieldparam result [Google::Apis::CloudbillingV1::StreamResponse] parsed result object
562
+ # @yieldparam err [StandardError] error object if request failed
563
+ #
564
+ # @return [Google::Apis::CloudbillingV1::StreamResponse]
565
+ #
566
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
567
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
568
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
569
+ def stream_message(send_message_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
570
+ command = make_simple_command(:post, 'v1/message:stream', options)
571
+ command.request_representation = Google::Apis::CloudbillingV1::SendMessageRequest::Representation
572
+ command.request_object = send_message_request_object
573
+ command.response_representation = Google::Apis::CloudbillingV1::StreamResponse::Representation
574
+ command.response_class = Google::Apis::CloudbillingV1::StreamResponse
575
+ command.query['fields'] = fields unless fields.nil?
576
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
577
+ execute_or_queue_command(command, &block)
578
+ end
579
+
518
580
  # This method creates [billing subaccounts](https://cloud.google.com/billing/
519
581
  # docs/concepts#subaccounts). Google Cloud resellers should use the Channel
520
582
  # Services APIs, [accounts.customers.create](https://cloud.google.com/channel/
@@ -827,6 +889,300 @@ module Google
827
889
  command.query['quotaUser'] = quota_user unless quota_user.nil?
828
890
  execute_or_queue_command(command, &block)
829
891
  end
892
+
893
+ # Cancel a task from the agent. If supported one should expect no more task
894
+ # updates for the task.
895
+ # @param [String] name
896
+ # The resource name of the task to cancel. Format: tasks/`task_id`
897
+ # @param [Google::Apis::CloudbillingV1::CancelTaskRequest] cancel_task_request_object
898
+ # @param [String] fields
899
+ # Selector specifying which fields to include in a partial response.
900
+ # @param [String] quota_user
901
+ # Available to use for quota purposes for server-side applications. Can be any
902
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
903
+ # @param [Google::Apis::RequestOptions] options
904
+ # Request-specific options
905
+ #
906
+ # @yield [result, err] Result & error if block supplied
907
+ # @yieldparam result [Google::Apis::CloudbillingV1::Task] parsed result object
908
+ # @yieldparam err [StandardError] error object if request failed
909
+ #
910
+ # @return [Google::Apis::CloudbillingV1::Task]
911
+ #
912
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
913
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
914
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
915
+ def cancel_task(name, cancel_task_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
916
+ command = make_simple_command(:post, 'v1/{+name}:cancel', options)
917
+ command.request_representation = Google::Apis::CloudbillingV1::CancelTaskRequest::Representation
918
+ command.request_object = cancel_task_request_object
919
+ command.response_representation = Google::Apis::CloudbillingV1::Task::Representation
920
+ command.response_class = Google::Apis::CloudbillingV1::Task
921
+ command.params['name'] = name unless name.nil?
922
+ command.query['fields'] = fields unless fields.nil?
923
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
924
+ execute_or_queue_command(command, &block)
925
+ end
926
+
927
+ # Get the current state of a task from the agent.
928
+ # @param [String] name
929
+ # Required. The resource name of the task. Format: tasks/`task_id`
930
+ # @param [Fixnum] history_length
931
+ # The number of most recent messages from the task's history to retrieve.
932
+ # @param [String] tenant
933
+ # Optional tenant, provided as a path parameter. Experimental, might still
934
+ # change for 1.0 release.
935
+ # @param [String] fields
936
+ # Selector specifying which fields to include in a partial response.
937
+ # @param [String] quota_user
938
+ # Available to use for quota purposes for server-side applications. Can be any
939
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
940
+ # @param [Google::Apis::RequestOptions] options
941
+ # Request-specific options
942
+ #
943
+ # @yield [result, err] Result & error if block supplied
944
+ # @yieldparam result [Google::Apis::CloudbillingV1::Task] parsed result object
945
+ # @yieldparam err [StandardError] error object if request failed
946
+ #
947
+ # @return [Google::Apis::CloudbillingV1::Task]
948
+ #
949
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
950
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
951
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
952
+ def get_task(name, history_length: nil, tenant: nil, fields: nil, quota_user: nil, options: nil, &block)
953
+ command = make_simple_command(:get, 'v1/{+name}', options)
954
+ command.response_representation = Google::Apis::CloudbillingV1::Task::Representation
955
+ command.response_class = Google::Apis::CloudbillingV1::Task
956
+ command.params['name'] = name unless name.nil?
957
+ command.query['historyLength'] = history_length unless history_length.nil?
958
+ command.query['tenant'] = tenant unless tenant.nil?
959
+ command.query['fields'] = fields unless fields.nil?
960
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
961
+ execute_or_queue_command(command, &block)
962
+ end
963
+
964
+ # TaskSubscription is a streaming call that will return a stream of task update
965
+ # events. This attaches the stream to an existing in process task. If the task
966
+ # is complete the stream will return the completed task (like GetTask) and close
967
+ # the stream.
968
+ # @param [String] name
969
+ # The resource name of the task to subscribe to. Format: tasks/`task_id`
970
+ # @param [String] tenant
971
+ # Optional tenant, provided as a path parameter. Experimental, might still
972
+ # change for 1.0 release.
973
+ # @param [String] fields
974
+ # Selector specifying which fields to include in a partial response.
975
+ # @param [String] quota_user
976
+ # Available to use for quota purposes for server-side applications. Can be any
977
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
978
+ # @param [Google::Apis::RequestOptions] options
979
+ # Request-specific options
980
+ #
981
+ # @yield [result, err] Result & error if block supplied
982
+ # @yieldparam result [Google::Apis::CloudbillingV1::StreamResponse] parsed result object
983
+ # @yieldparam err [StandardError] error object if request failed
984
+ #
985
+ # @return [Google::Apis::CloudbillingV1::StreamResponse]
986
+ #
987
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
988
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
989
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
990
+ def subscribe_task(name, tenant: nil, fields: nil, quota_user: nil, options: nil, &block)
991
+ command = make_simple_command(:get, 'v1/{+name}:subscribe', options)
992
+ command.response_representation = Google::Apis::CloudbillingV1::StreamResponse::Representation
993
+ command.response_class = Google::Apis::CloudbillingV1::StreamResponse
994
+ command.params['name'] = name unless name.nil?
995
+ command.query['tenant'] = tenant unless tenant.nil?
996
+ command.query['fields'] = fields unless fields.nil?
997
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
998
+ execute_or_queue_command(command, &block)
999
+ end
1000
+
1001
+ # Set a push notification config for a task.
1002
+ # @param [String] parent
1003
+ # Required. The parent task resource for this config. Format: tasks/`task_id`
1004
+ # @param [Google::Apis::CloudbillingV1::TaskPushNotificationConfig] task_push_notification_config_object
1005
+ # @param [String] config_id
1006
+ # Required. The ID for the new config.
1007
+ # @param [String] tenant
1008
+ # Optional tenant, provided as a path parameter. Experimental, might still
1009
+ # change for 1.0 release.
1010
+ # @param [String] fields
1011
+ # Selector specifying which fields to include in a partial response.
1012
+ # @param [String] quota_user
1013
+ # Available to use for quota purposes for server-side applications. Can be any
1014
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1015
+ # @param [Google::Apis::RequestOptions] options
1016
+ # Request-specific options
1017
+ #
1018
+ # @yield [result, err] Result & error if block supplied
1019
+ # @yieldparam result [Google::Apis::CloudbillingV1::TaskPushNotificationConfig] parsed result object
1020
+ # @yieldparam err [StandardError] error object if request failed
1021
+ #
1022
+ # @return [Google::Apis::CloudbillingV1::TaskPushNotificationConfig]
1023
+ #
1024
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1025
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1026
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1027
+ def create_task_push_notification_config(parent, task_push_notification_config_object = nil, config_id: nil, tenant: nil, fields: nil, quota_user: nil, options: nil, &block)
1028
+ command = make_simple_command(:post, 'v1/{+parent}', options)
1029
+ command.request_representation = Google::Apis::CloudbillingV1::TaskPushNotificationConfig::Representation
1030
+ command.request_object = task_push_notification_config_object
1031
+ command.response_representation = Google::Apis::CloudbillingV1::TaskPushNotificationConfig::Representation
1032
+ command.response_class = Google::Apis::CloudbillingV1::TaskPushNotificationConfig
1033
+ command.params['parent'] = parent unless parent.nil?
1034
+ command.query['configId'] = config_id unless config_id.nil?
1035
+ command.query['tenant'] = tenant unless tenant.nil?
1036
+ command.query['fields'] = fields unless fields.nil?
1037
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1038
+ execute_or_queue_command(command, &block)
1039
+ end
1040
+
1041
+ # Delete a push notification config for a task.
1042
+ # @param [String] name
1043
+ # The resource name of the config to delete. Format: tasks/`task_id`/
1044
+ # pushNotificationConfigs/`config_id`
1045
+ # @param [String] tenant
1046
+ # Optional tenant, provided as a path parameter. Experimental, might still
1047
+ # change for 1.0 release.
1048
+ # @param [String] fields
1049
+ # Selector specifying which fields to include in a partial response.
1050
+ # @param [String] quota_user
1051
+ # Available to use for quota purposes for server-side applications. Can be any
1052
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1053
+ # @param [Google::Apis::RequestOptions] options
1054
+ # Request-specific options
1055
+ #
1056
+ # @yield [result, err] Result & error if block supplied
1057
+ # @yieldparam result [Google::Apis::CloudbillingV1::Empty] parsed result object
1058
+ # @yieldparam err [StandardError] error object if request failed
1059
+ #
1060
+ # @return [Google::Apis::CloudbillingV1::Empty]
1061
+ #
1062
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1063
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1064
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1065
+ def delete_task_push_notification_config(name, tenant: nil, fields: nil, quota_user: nil, options: nil, &block)
1066
+ command = make_simple_command(:delete, 'v1/{+name}', options)
1067
+ command.response_representation = Google::Apis::CloudbillingV1::Empty::Representation
1068
+ command.response_class = Google::Apis::CloudbillingV1::Empty
1069
+ command.params['name'] = name unless name.nil?
1070
+ command.query['tenant'] = tenant unless tenant.nil?
1071
+ command.query['fields'] = fields unless fields.nil?
1072
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1073
+ execute_or_queue_command(command, &block)
1074
+ end
1075
+
1076
+ # Get a push notification config for a task.
1077
+ # @param [String] name
1078
+ # The resource name of the config to retrieve. Format: tasks/`task_id`/
1079
+ # pushNotificationConfigs/`config_id`
1080
+ # @param [String] tenant
1081
+ # Optional tenant, provided as a path parameter. Experimental, might still
1082
+ # change for 1.0 release.
1083
+ # @param [String] fields
1084
+ # Selector specifying which fields to include in a partial response.
1085
+ # @param [String] quota_user
1086
+ # Available to use for quota purposes for server-side applications. Can be any
1087
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1088
+ # @param [Google::Apis::RequestOptions] options
1089
+ # Request-specific options
1090
+ #
1091
+ # @yield [result, err] Result & error if block supplied
1092
+ # @yieldparam result [Google::Apis::CloudbillingV1::TaskPushNotificationConfig] parsed result object
1093
+ # @yieldparam err [StandardError] error object if request failed
1094
+ #
1095
+ # @return [Google::Apis::CloudbillingV1::TaskPushNotificationConfig]
1096
+ #
1097
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1098
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1099
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1100
+ def get_task_push_notification_config(name, tenant: nil, fields: nil, quota_user: nil, options: nil, &block)
1101
+ command = make_simple_command(:get, 'v1/{+name}', options)
1102
+ command.response_representation = Google::Apis::CloudbillingV1::TaskPushNotificationConfig::Representation
1103
+ command.response_class = Google::Apis::CloudbillingV1::TaskPushNotificationConfig
1104
+ command.params['name'] = name unless name.nil?
1105
+ command.query['tenant'] = tenant unless tenant.nil?
1106
+ command.query['fields'] = fields unless fields.nil?
1107
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1108
+ execute_or_queue_command(command, &block)
1109
+ end
1110
+
1111
+ # Get a list of push notifications configured for a task.
1112
+ # @param [String] parent
1113
+ # The parent task resource. Format: tasks/`task_id`
1114
+ # @param [Fixnum] page_size
1115
+ # For AIP-158 these fields are present. Usually not used/needed. The maximum
1116
+ # number of configurations to return. If unspecified, all configs will be
1117
+ # returned.
1118
+ # @param [String] page_token
1119
+ # A page token received from a previous ListTaskPushNotificationConfigRequest
1120
+ # call. Provide this to retrieve the subsequent page. When paginating, all other
1121
+ # parameters provided to `ListTaskPushNotificationConfigRequest` must match the
1122
+ # call that provided the page token.
1123
+ # @param [String] tenant
1124
+ # Optional tenant, provided as a path parameter. Experimental, might still
1125
+ # change for 1.0 release.
1126
+ # @param [String] fields
1127
+ # Selector specifying which fields to include in a partial response.
1128
+ # @param [String] quota_user
1129
+ # Available to use for quota purposes for server-side applications. Can be any
1130
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1131
+ # @param [Google::Apis::RequestOptions] options
1132
+ # Request-specific options
1133
+ #
1134
+ # @yield [result, err] Result & error if block supplied
1135
+ # @yieldparam result [Google::Apis::CloudbillingV1::ListTaskPushNotificationConfigResponse] parsed result object
1136
+ # @yieldparam err [StandardError] error object if request failed
1137
+ #
1138
+ # @return [Google::Apis::CloudbillingV1::ListTaskPushNotificationConfigResponse]
1139
+ #
1140
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1141
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1142
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1143
+ def list_task_push_notification_configs(parent, page_size: nil, page_token: nil, tenant: nil, fields: nil, quota_user: nil, options: nil, &block)
1144
+ command = make_simple_command(:get, 'v1/{+parent}/pushNotificationConfigs', options)
1145
+ command.response_representation = Google::Apis::CloudbillingV1::ListTaskPushNotificationConfigResponse::Representation
1146
+ command.response_class = Google::Apis::CloudbillingV1::ListTaskPushNotificationConfigResponse
1147
+ command.params['parent'] = parent unless parent.nil?
1148
+ command.query['pageSize'] = page_size unless page_size.nil?
1149
+ command.query['pageToken'] = page_token unless page_token.nil?
1150
+ command.query['tenant'] = tenant unless tenant.nil?
1151
+ command.query['fields'] = fields unless fields.nil?
1152
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1153
+ execute_or_queue_command(command, &block)
1154
+ end
1155
+
1156
+ # GetAgentCard returns the agent card for the agent.
1157
+ # @param [String] tenant
1158
+ # Optional tenant, provided as a path parameter. Experimental, might still
1159
+ # change for 1.0 release.
1160
+ # @param [String] fields
1161
+ # Selector specifying which fields to include in a partial response.
1162
+ # @param [String] quota_user
1163
+ # Available to use for quota purposes for server-side applications. Can be any
1164
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1165
+ # @param [Google::Apis::RequestOptions] options
1166
+ # Request-specific options
1167
+ #
1168
+ # @yield [result, err] Result & error if block supplied
1169
+ # @yieldparam result [Google::Apis::CloudbillingV1::AgentCard] parsed result object
1170
+ # @yieldparam err [StandardError] error object if request failed
1171
+ #
1172
+ # @return [Google::Apis::CloudbillingV1::AgentCard]
1173
+ #
1174
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1175
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1176
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1177
+ def get_card(tenant: nil, fields: nil, quota_user: nil, options: nil, &block)
1178
+ command = make_simple_command(:get, 'v1/card', options)
1179
+ command.response_representation = Google::Apis::CloudbillingV1::AgentCard::Representation
1180
+ command.response_class = Google::Apis::CloudbillingV1::AgentCard
1181
+ command.query['tenant'] = tenant unless tenant.nil?
1182
+ command.query['fields'] = fields unless fields.nil?
1183
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1184
+ execute_or_queue_command(command, &block)
1185
+ end
830
1186
 
831
1187
  protected
832
1188
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-cloudbilling_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.40.0
4
+ version: 0.41.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
@@ -57,7 +57,7 @@ licenses:
57
57
  metadata:
58
58
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
59
59
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-cloudbilling_v1/CHANGELOG.md
60
- documentation_uri: https://googleapis.dev/ruby/google-apis-cloudbilling_v1/v0.40.0
60
+ documentation_uri: https://googleapis.dev/ruby/google-apis-cloudbilling_v1/v0.41.0
61
61
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-cloudbilling_v1
62
62
  rdoc_options: []
63
63
  require_paths: