google-cloud-support-v2beta 0.1.0 → 0.1.1

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.
@@ -207,35 +207,6 @@ module Google
207
207
  ##
208
208
  # Retrieve a case.
209
209
  #
210
- # EXAMPLES:
211
- #
212
- # cURL:
213
- #
214
- # ```shell
215
- # case="projects/some-project/cases/16033687"
216
- # curl \
217
- # --header "Authorization: Bearer $(gcloud auth print-access-token)" \
218
- # "https://cloudsupport.googleapis.com/v2/$case"
219
- # ```
220
- #
221
- # Python:
222
- #
223
- # ```python
224
- # import googleapiclient.discovery
225
- #
226
- # api_version = "v2"
227
- # supportApiService = googleapiclient.discovery.build(
228
- # serviceName="cloudsupport",
229
- # version=api_version,
230
- # discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=\\{api_version}",
231
- # )
232
- #
233
- # request = supportApiService.cases().get(
234
- # name="projects/some-project/cases/43595344",
235
- # )
236
- # print(request.execute())
237
- # ```
238
- #
239
210
  # @overload get_case(request, options = nil)
240
211
  # Pass arguments to `get_case` via a request object, either of type
241
212
  # {::Google::Cloud::Support::V2beta::GetCaseRequest} or an equivalent Hash.
@@ -318,34 +289,6 @@ module Google
318
289
  # that are directly parented by that organization. To retrieve cases
319
290
  # under an organization and its projects, use `cases.search`.
320
291
  #
321
- # EXAMPLES:
322
- #
323
- # cURL:
324
- #
325
- # ```shell
326
- # parent="projects/some-project"
327
- # curl \
328
- # --header "Authorization: Bearer $(gcloud auth print-access-token)" \
329
- # "https://cloudsupport.googleapis.com/v2/$parent/cases"
330
- # ```
331
- #
332
- # Python:
333
- #
334
- # ```python
335
- # import googleapiclient.discovery
336
- #
337
- # api_version = "v2"
338
- # supportApiService = googleapiclient.discovery.build(
339
- # serviceName="cloudsupport",
340
- # version=api_version,
341
- # discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=\\{api_version}",
342
- # )
343
- #
344
- # request =
345
- # supportApiService.cases().list(parent="projects/some-project")
346
- # print(request.execute())
347
- # ```
348
- #
349
292
  # @overload list_cases(request, options = nil)
350
293
  # Pass arguments to `list_cases` via a request object, either of type
351
294
  # {::Google::Cloud::Support::V2beta::ListCasesRequest} or an equivalent Hash.
@@ -458,34 +401,6 @@ module Google
458
401
  ##
459
402
  # Search for cases using a query.
460
403
  #
461
- # EXAMPLES:
462
- #
463
- # cURL:
464
- #
465
- # ```shell
466
- # parent="projects/some-project"
467
- # curl \
468
- # --header "Authorization: Bearer $(gcloud auth print-access-token)" \
469
- # "https://cloudsupport.googleapis.com/v2/$parent/cases:search"
470
- # ```
471
- #
472
- # Python:
473
- #
474
- # ```python
475
- # import googleapiclient.discovery
476
- #
477
- # api_version = "v2"
478
- # supportApiService = googleapiclient.discovery.build(
479
- # serviceName="cloudsupport",
480
- # version=api_version,
481
- # discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=\\{api_version}",
482
- # )
483
- # request = supportApiService.cases().search(
484
- # parent="projects/some-project", query="state=OPEN"
485
- # )
486
- # print(request.execute())
487
- # ```
488
- #
489
404
  # @overload search_cases(request, options = nil)
490
405
  # Pass arguments to `search_cases` via a request object, either of type
491
406
  # {::Google::Cloud::Support::V2beta::SearchCasesRequest} or an equivalent Hash.
@@ -613,61 +528,6 @@ module Google
613
528
  # `classification`, and `priority`. If you're just testing the API and don't
614
529
  # want to route your case to an agent, set `testCase=true`.
615
530
  #
616
- # EXAMPLES:
617
- #
618
- # cURL:
619
- #
620
- # ```shell
621
- # parent="projects/some-project"
622
- # curl \
623
- # --request POST \
624
- # --header "Authorization: Bearer $(gcloud auth print-access-token)" \
625
- # --header 'Content-Type: application/json' \
626
- # --data '{
627
- # "display_name": "Test case created by me.",
628
- # "description": "a random test case, feel free to close",
629
- # "classification": {
630
- # "id":
631
- # "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8"
632
- # },
633
- # "time_zone": "-07:00",
634
- # "subscriber_email_addresses": [
635
- # "foo@domain.com",
636
- # "bar@domain.com"
637
- # ],
638
- # "testCase": true,
639
- # "priority": "P3"
640
- # }' \
641
- # "https://cloudsupport.googleapis.com/v2/$parent/cases"
642
- # ```
643
- #
644
- # Python:
645
- #
646
- # ```python
647
- # import googleapiclient.discovery
648
- #
649
- # api_version = "v2"
650
- # supportApiService = googleapiclient.discovery.build(
651
- # serviceName="cloudsupport",
652
- # version=api_version,
653
- # discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=\\{api_version}",
654
- # )
655
- # request = supportApiService.cases().create(
656
- # parent="projects/some-project",
657
- # body={
658
- # "displayName": "A Test Case",
659
- # "description": "This is a test case.",
660
- # "testCase": True,
661
- # "priority": "P2",
662
- # "classification": {
663
- # "id":
664
- # "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8"
665
- # },
666
- # },
667
- # )
668
- # print(request.execute())
669
- # ```
670
- #
671
531
  # @overload create_case(request, options = nil)
672
532
  # Pass arguments to `create_case` via a request object, either of type
673
533
  # {::Google::Cloud::Support::V2beta::CreateCaseRequest} or an equivalent Hash.
@@ -748,43 +608,6 @@ module Google
748
608
  ##
749
609
  # Update a case. Only some fields can be updated.
750
610
  #
751
- # EXAMPLES:
752
- #
753
- # cURL:
754
- #
755
- # ```shell
756
- # case="projects/some-project/cases/43595344"
757
- # curl \
758
- # --request PATCH \
759
- # --header "Authorization: Bearer $(gcloud auth print-access-token)" \
760
- # --header "Content-Type: application/json" \
761
- # --data '{
762
- # "priority": "P1"
763
- # }' \
764
- # "https://cloudsupport.googleapis.com/v2/$case?updateMask=priority"
765
- # ```
766
- #
767
- # Python:
768
- #
769
- # ```python
770
- # import googleapiclient.discovery
771
- #
772
- # api_version = "v2"
773
- # supportApiService = googleapiclient.discovery.build(
774
- # serviceName="cloudsupport",
775
- # version=api_version,
776
- # discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=\\{api_version}",
777
- # )
778
- # request = supportApiService.cases().patch(
779
- # name="projects/some-project/cases/43112854",
780
- # body={
781
- # "displayName": "This is Now a New Title",
782
- # "priority": "P2",
783
- # },
784
- # )
785
- # print(request.execute())
786
- # ```
787
- #
788
611
  # @overload update_case(request, options = nil)
789
612
  # Pass arguments to `update_case` via a request object, either of type
790
613
  # {::Google::Cloud::Support::V2beta::UpdateCaseRequest} or an equivalent Hash.
@@ -878,48 +701,6 @@ module Google
878
701
  # escalations' in the feature list to find out which ones let you
879
702
  # do that.
880
703
  #
881
- # EXAMPLES:
882
- #
883
- # cURL:
884
- #
885
- # ```shell
886
- # case="projects/some-project/cases/43595344"
887
- # curl \
888
- # --request POST \
889
- # --header "Authorization: Bearer $(gcloud auth print-access-token)" \
890
- # --header "Content-Type: application/json" \
891
- # --data '{
892
- # "escalation": {
893
- # "reason": "BUSINESS_IMPACT",
894
- # "justification": "This is a test escalation."
895
- # }
896
- # }' \
897
- # "https://cloudsupport.googleapis.com/v2/$case:escalate"
898
- # ```
899
- #
900
- # Python:
901
- #
902
- # ```python
903
- # import googleapiclient.discovery
904
- #
905
- # api_version = "v2"
906
- # supportApiService = googleapiclient.discovery.build(
907
- # serviceName="cloudsupport",
908
- # version=api_version,
909
- # discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=\\{api_version}",
910
- # )
911
- # request = supportApiService.cases().escalate(
912
- # name="projects/some-project/cases/43595344",
913
- # body={
914
- # "escalation": {
915
- # "reason": "BUSINESS_IMPACT",
916
- # "justification": "This is a test escalation.",
917
- # },
918
- # },
919
- # )
920
- # print(request.execute())
921
- # ```
922
- #
923
704
  # @overload escalate_case(request, options = nil)
924
705
  # Pass arguments to `escalate_case` via a request object, either of type
925
706
  # {::Google::Cloud::Support::V2beta::EscalateCaseRequest} or an equivalent Hash.
@@ -1000,35 +781,6 @@ module Google
1000
781
  ##
1001
782
  # Close a case.
1002
783
  #
1003
- # EXAMPLES:
1004
- #
1005
- # cURL:
1006
- #
1007
- # ```shell
1008
- # case="projects/some-project/cases/43595344"
1009
- # curl \
1010
- # --request POST \
1011
- # --header "Authorization: Bearer $(gcloud auth print-access-token)" \
1012
- # "https://cloudsupport.googleapis.com/v2/$case:close"
1013
- # ```
1014
- #
1015
- # Python:
1016
- #
1017
- # ```python
1018
- # import googleapiclient.discovery
1019
- #
1020
- # api_version = "v2"
1021
- # supportApiService = googleapiclient.discovery.build(
1022
- # serviceName="cloudsupport",
1023
- # version=api_version,
1024
- # discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=\\{api_version}",
1025
- # )
1026
- # request = supportApiService.cases().close(
1027
- # name="projects/some-project/cases/43595344"
1028
- # )
1029
- # print(request.execute())
1030
- # ```
1031
- #
1032
784
  # @overload close_case(request, options = nil)
1033
785
  # Pass arguments to `close_case` via a request object, either of type
1034
786
  # {::Google::Cloud::Support::V2beta::CloseCaseRequest} or an equivalent Hash.
@@ -1116,32 +868,6 @@ module Google
1116
868
  # stops returning it. After six months, `case.create` requests using the
1117
869
  # classification will fail.
1118
870
  #
1119
- # EXAMPLES:
1120
- #
1121
- # cURL:
1122
- #
1123
- # ```shell
1124
- # curl \
1125
- # --header "Authorization: Bearer $(gcloud auth print-access-token)" \
1126
- # 'https://cloudsupport.googleapis.com/v2/caseClassifications:search?query=display_name:"*Compute%20Engine*"'
1127
- # ```
1128
- #
1129
- # Python:
1130
- #
1131
- # ```python
1132
- # import googleapiclient.discovery
1133
- #
1134
- # supportApiService = googleapiclient.discovery.build(
1135
- # serviceName="cloudsupport",
1136
- # version="v2",
1137
- # discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=v2",
1138
- # )
1139
- # request = supportApiService.caseClassifications().search(
1140
- # query='display_name:"*Compute Engine*"'
1141
- # )
1142
- # print(request.execute())
1143
- # ```
1144
- #
1145
871
  # @overload search_case_classifications(request, options = nil)
1146
872
  # Pass arguments to `search_case_classifications` via a request object, either of type
1147
873
  # {::Google::Cloud::Support::V2beta::SearchCaseClassificationsRequest} or an equivalent Hash.
@@ -34,199 +34,22 @@ module Google
34
34
  self.service_name = 'google.cloud.support.v2beta.CaseService'
35
35
 
36
36
  # Retrieve a case.
37
- #
38
- # EXAMPLES:
39
- #
40
- # cURL:
41
- #
42
- # ```shell
43
- # case="projects/some-project/cases/16033687"
44
- # curl \
45
- # --header "Authorization: Bearer $(gcloud auth print-access-token)" \
46
- # "https://cloudsupport.googleapis.com/v2/$case"
47
- # ```
48
- #
49
- # Python:
50
- #
51
- # ```python
52
- # import googleapiclient.discovery
53
- #
54
- # api_version = "v2"
55
- # supportApiService = googleapiclient.discovery.build(
56
- # serviceName="cloudsupport",
57
- # version=api_version,
58
- # discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}",
59
- # )
60
- #
61
- # request = supportApiService.cases().get(
62
- # name="projects/some-project/cases/43595344",
63
- # )
64
- # print(request.execute())
65
- # ```
66
37
  rpc :GetCase, ::Google::Cloud::Support::V2beta::GetCaseRequest, ::Google::Cloud::Support::V2beta::Case
67
38
  # Retrieve all cases under a parent, but not its children.
68
39
  #
69
40
  # For example, listing cases under an organization only returns the cases
70
41
  # that are directly parented by that organization. To retrieve cases
71
42
  # under an organization and its projects, use `cases.search`.
72
- #
73
- # EXAMPLES:
74
- #
75
- # cURL:
76
- #
77
- # ```shell
78
- # parent="projects/some-project"
79
- # curl \
80
- # --header "Authorization: Bearer $(gcloud auth print-access-token)" \
81
- # "https://cloudsupport.googleapis.com/v2/$parent/cases"
82
- # ```
83
- #
84
- # Python:
85
- #
86
- # ```python
87
- # import googleapiclient.discovery
88
- #
89
- # api_version = "v2"
90
- # supportApiService = googleapiclient.discovery.build(
91
- # serviceName="cloudsupport",
92
- # version=api_version,
93
- # discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}",
94
- # )
95
- #
96
- # request =
97
- # supportApiService.cases().list(parent="projects/some-project")
98
- # print(request.execute())
99
- # ```
100
43
  rpc :ListCases, ::Google::Cloud::Support::V2beta::ListCasesRequest, ::Google::Cloud::Support::V2beta::ListCasesResponse
101
44
  # Search for cases using a query.
102
- #
103
- # EXAMPLES:
104
- #
105
- # cURL:
106
- #
107
- # ```shell
108
- # parent="projects/some-project"
109
- # curl \
110
- # --header "Authorization: Bearer $(gcloud auth print-access-token)" \
111
- # "https://cloudsupport.googleapis.com/v2/$parent/cases:search"
112
- # ```
113
- #
114
- # Python:
115
- #
116
- # ```python
117
- # import googleapiclient.discovery
118
- #
119
- # api_version = "v2"
120
- # supportApiService = googleapiclient.discovery.build(
121
- # serviceName="cloudsupport",
122
- # version=api_version,
123
- # discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}",
124
- # )
125
- # request = supportApiService.cases().search(
126
- # parent="projects/some-project", query="state=OPEN"
127
- # )
128
- # print(request.execute())
129
- # ```
130
45
  rpc :SearchCases, ::Google::Cloud::Support::V2beta::SearchCasesRequest, ::Google::Cloud::Support::V2beta::SearchCasesResponse
131
46
  # Create a new case and associate it with a parent.
132
47
  #
133
48
  # It must have the following fields set: `display_name`, `description`,
134
49
  # `classification`, and `priority`. If you're just testing the API and don't
135
50
  # want to route your case to an agent, set `testCase=true`.
136
- #
137
- # EXAMPLES:
138
- #
139
- # cURL:
140
- #
141
- # ```shell
142
- # parent="projects/some-project"
143
- # curl \
144
- # --request POST \
145
- # --header "Authorization: Bearer $(gcloud auth print-access-token)" \
146
- # --header 'Content-Type: application/json' \
147
- # --data '{
148
- # "display_name": "Test case created by me.",
149
- # "description": "a random test case, feel free to close",
150
- # "classification": {
151
- # "id":
152
- # "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8"
153
- # },
154
- # "time_zone": "-07:00",
155
- # "subscriber_email_addresses": [
156
- # "foo@domain.com",
157
- # "bar@domain.com"
158
- # ],
159
- # "testCase": true,
160
- # "priority": "P3"
161
- # }' \
162
- # "https://cloudsupport.googleapis.com/v2/$parent/cases"
163
- # ```
164
- #
165
- # Python:
166
- #
167
- # ```python
168
- # import googleapiclient.discovery
169
- #
170
- # api_version = "v2"
171
- # supportApiService = googleapiclient.discovery.build(
172
- # serviceName="cloudsupport",
173
- # version=api_version,
174
- # discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}",
175
- # )
176
- # request = supportApiService.cases().create(
177
- # parent="projects/some-project",
178
- # body={
179
- # "displayName": "A Test Case",
180
- # "description": "This is a test case.",
181
- # "testCase": True,
182
- # "priority": "P2",
183
- # "classification": {
184
- # "id":
185
- # "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8"
186
- # },
187
- # },
188
- # )
189
- # print(request.execute())
190
- # ```
191
51
  rpc :CreateCase, ::Google::Cloud::Support::V2beta::CreateCaseRequest, ::Google::Cloud::Support::V2beta::Case
192
52
  # Update a case. Only some fields can be updated.
193
- #
194
- # EXAMPLES:
195
- #
196
- # cURL:
197
- #
198
- # ```shell
199
- # case="projects/some-project/cases/43595344"
200
- # curl \
201
- # --request PATCH \
202
- # --header "Authorization: Bearer $(gcloud auth print-access-token)" \
203
- # --header "Content-Type: application/json" \
204
- # --data '{
205
- # "priority": "P1"
206
- # }' \
207
- # "https://cloudsupport.googleapis.com/v2/$case?updateMask=priority"
208
- # ```
209
- #
210
- # Python:
211
- #
212
- # ```python
213
- # import googleapiclient.discovery
214
- #
215
- # api_version = "v2"
216
- # supportApiService = googleapiclient.discovery.build(
217
- # serviceName="cloudsupport",
218
- # version=api_version,
219
- # discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}",
220
- # )
221
- # request = supportApiService.cases().patch(
222
- # name="projects/some-project/cases/43112854",
223
- # body={
224
- # "displayName": "This is Now a New Title",
225
- # "priority": "P2",
226
- # },
227
- # )
228
- # print(request.execute())
229
- # ```
230
53
  rpc :UpdateCase, ::Google::Cloud::Support::V2beta::UpdateCaseRequest, ::Google::Cloud::Support::V2beta::Case
231
54
  # Escalate a case, starting the Google Cloud Support escalation management
232
55
  # process.
@@ -235,79 +58,8 @@ module Google
235
58
  # https://cloud.google.com/support and look for 'Technical support
236
59
  # escalations' in the feature list to find out which ones let you
237
60
  # do that.
238
- #
239
- # EXAMPLES:
240
- #
241
- # cURL:
242
- #
243
- # ```shell
244
- # case="projects/some-project/cases/43595344"
245
- # curl \
246
- # --request POST \
247
- # --header "Authorization: Bearer $(gcloud auth print-access-token)" \
248
- # --header "Content-Type: application/json" \
249
- # --data '{
250
- # "escalation": {
251
- # "reason": "BUSINESS_IMPACT",
252
- # "justification": "This is a test escalation."
253
- # }
254
- # }' \
255
- # "https://cloudsupport.googleapis.com/v2/$case:escalate"
256
- # ```
257
- #
258
- # Python:
259
- #
260
- # ```python
261
- # import googleapiclient.discovery
262
- #
263
- # api_version = "v2"
264
- # supportApiService = googleapiclient.discovery.build(
265
- # serviceName="cloudsupport",
266
- # version=api_version,
267
- # discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}",
268
- # )
269
- # request = supportApiService.cases().escalate(
270
- # name="projects/some-project/cases/43595344",
271
- # body={
272
- # "escalation": {
273
- # "reason": "BUSINESS_IMPACT",
274
- # "justification": "This is a test escalation.",
275
- # },
276
- # },
277
- # )
278
- # print(request.execute())
279
- # ```
280
61
  rpc :EscalateCase, ::Google::Cloud::Support::V2beta::EscalateCaseRequest, ::Google::Cloud::Support::V2beta::Case
281
62
  # Close a case.
282
- #
283
- # EXAMPLES:
284
- #
285
- # cURL:
286
- #
287
- # ```shell
288
- # case="projects/some-project/cases/43595344"
289
- # curl \
290
- # --request POST \
291
- # --header "Authorization: Bearer $(gcloud auth print-access-token)" \
292
- # "https://cloudsupport.googleapis.com/v2/$case:close"
293
- # ```
294
- #
295
- # Python:
296
- #
297
- # ```python
298
- # import googleapiclient.discovery
299
- #
300
- # api_version = "v2"
301
- # supportApiService = googleapiclient.discovery.build(
302
- # serviceName="cloudsupport",
303
- # version=api_version,
304
- # discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}",
305
- # )
306
- # request = supportApiService.cases().close(
307
- # name="projects/some-project/cases/43595344"
308
- # )
309
- # print(request.execute())
310
- # ```
311
63
  rpc :CloseCase, ::Google::Cloud::Support::V2beta::CloseCaseRequest, ::Google::Cloud::Support::V2beta::Case
312
64
  # Retrieve valid classifications to use when creating a support case.
313
65
  #
@@ -319,32 +71,6 @@ module Google
319
71
  # months. When a classification is deactivated, this endpoint immediately
320
72
  # stops returning it. After six months, `case.create` requests using the
321
73
  # classification will fail.
322
- #
323
- # EXAMPLES:
324
- #
325
- # cURL:
326
- #
327
- # ```shell
328
- # curl \
329
- # --header "Authorization: Bearer $(gcloud auth print-access-token)" \
330
- # 'https://cloudsupport.googleapis.com/v2/caseClassifications:search?query=display_name:"*Compute%20Engine*"'
331
- # ```
332
- #
333
- # Python:
334
- #
335
- # ```python
336
- # import googleapiclient.discovery
337
- #
338
- # supportApiService = googleapiclient.discovery.build(
339
- # serviceName="cloudsupport",
340
- # version="v2",
341
- # discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version=v2",
342
- # )
343
- # request = supportApiService.caseClassifications().search(
344
- # query='display_name:"*Compute Engine*"'
345
- # )
346
- # print(request.execute())
347
- # ```
348
74
  rpc :SearchCaseClassifications, ::Google::Cloud::Support::V2beta::SearchCaseClassificationsRequest, ::Google::Cloud::Support::V2beta::SearchCaseClassificationsResponse
349
75
  end
350
76