Skip to content

Commit f5e91e7

Browse files
yoshi-automationyoshi-automation
committed
feat(sasportal): update the api
#### sasportal:v1alpha1 The following keys were added: - resources.customers.methods.checkHasProvisionedDeployment (Total Keys: 7) - resources.customers.methods.migrateOrganization (Total Keys: 8) - schemas.SasPortalCheckHasProvisionedDeploymentResponse (Total Keys: 3) - schemas.SasPortalDeploymentAssociation (Total Keys: 4) - schemas.SasPortalMigrateOrganizationMetadata (Total Keys: 4) - schemas.SasPortalMigrateOrganizationRequest (Total Keys: 4) - schemas.SasPortalMigrateOrganizationResponse (Total Keys: 4)
1 parent 574b1f1 commit f5e91e7

File tree

2 files changed

+179
-1
lines changed

2 files changed

+179
-1
lines changed

‎docs/dyn/sasportal_v1alpha1.customers.html

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,9 @@ <h2>Instance Methods</h2>
8989
</p>
9090
<p class="firstline">Returns the nodes Resource.</p>
9191

92+
<p class="toc_element">
93+
<code><a href="#checkHasProvisionedDeployment">checkHasProvisionedDeployment(x__xgafv=None)</a></code></p>
94+
<p class="firstline">Checks whether a SAS deployment for the authentication context exists.</p>
9295
<p class="toc_element">
9396
<code><a href="#close">close()</a></code></p>
9497
<p class="firstline">Close httplib2 connections.</p>
@@ -101,13 +104,34 @@ <h2>Instance Methods</h2>
101104
<p class="toc_element">
102105
<code><a href="#list_next">list_next()</a></code></p>
103106
<p class="firstline">Retrieves the next page of results.</p>
107+
<p class="toc_element">
108+
<code><a href="#migrateOrganization">migrateOrganization(body=None, x__xgafv=None)</a></code></p>
109+
<p class="firstline">Migrates a SAS organization to the cloud. This will create GCP projects for each deployment and associate them. The SAS Organization is linked to the gcp project that called the command. go/sas-legacy-customer-migration</p>
104110
<p class="toc_element">
105111
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
106112
<p class="firstline">Updates an existing customer.</p>
107113
<p class="toc_element">
108114
<code><a href="#provisionDeployment">provisionDeployment(body=None, x__xgafv=None)</a></code></p>
109115
<p class="firstline">Creates a new SAS deployment through the GCP workflow. Creates a SAS organization if an organization match is not found.</p>
110116
<h3>Method Details</h3>
117+
<div class="method">
118+
<code class="details" id="checkHasProvisionedDeployment">checkHasProvisionedDeployment(x__xgafv=None)</code>
119+
<pre>Checks whether a SAS deployment for the authentication context exists.
120+
121+
Args:
122+
x__xgafv: string, V1 error format.
123+
Allowed values
124+
1 - v1 error format
125+
2 - v2 error format
126+
127+
Returns:
128+
An object of the form:
129+
130+
{ # Response for [CheckHasProvisionedDeployment]. [spectrum.sas.portal.v1alpha1.Provisioning.CheckHasProvisionedDeployment].
131+
&quot;hasProvisionedDeployment&quot;: True or False, # Whether a SAS deployment for the authentication context exists.
132+
}</pre>
133+
</div>
134+
111135
<div class="method">
112136
<code class="details" id="close">close()</code>
113137
<pre>Close httplib2 connections.</pre>
@@ -179,6 +203,47 @@ <h3>Method Details</h3>
179203
</pre>
180204
</div>
181205

206+
<div class="method">
207+
<code class="details" id="migrateOrganization">migrateOrganization(body=None, x__xgafv=None)</code>
208+
<pre>Migrates a SAS organization to the cloud. This will create GCP projects for each deployment and associate them. The SAS Organization is linked to the gcp project that called the command. go/sas-legacy-customer-migration
209+
210+
Args:
211+
body: object, The request body.
212+
The object takes the form of:
213+
214+
{ # Request for [MigrateOrganization]. [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. GCP Project, Organization Info, and caller&#x27;s GAIA ID should be retrieved from the RPC handler, and used to check authorization on SAS Portal organization and to create GCP Projects.
215+
&quot;organizationId&quot;: &quot;A String&quot;, # Required. Id of the SAS organization to be migrated.
216+
}
217+
218+
x__xgafv: string, V1 error format.
219+
Allowed values
220+
1 - v1 error format
221+
2 - v2 error format
222+
223+
Returns:
224+
An object of the form:
225+
226+
{ # This resource represents a long-running operation that is the result of a network API call.
227+
&quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
228+
&quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
229+
&quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
230+
&quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
231+
{
232+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
233+
},
234+
],
235+
&quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
236+
},
237+
&quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
238+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
239+
},
240+
&quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
241+
&quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
242+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
243+
},
244+
}</pre>
245+
</div>
246+
182247
<div class="method">
183248
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
184249
<pre>Updates an existing customer.

‎googleapiclient/discovery_cache/documents/sasportal.v1alpha1.json

Lines changed: 114 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,22 @@
109109
"resources": {
110110
"customers": {
111111
"methods": {
112+
"checkHasProvisionedDeployment": {
113+
"description": "Checks whether a SAS deployment for the authentication context exists.",
114+
"flatPath": "v1alpha1/customers:checkHasProvisionedDeployment",
115+
"httpMethod": "GET",
116+
"id": "sasportal.customers.checkHasProvisionedDeployment",
117+
"parameterOrder": [],
118+
"parameters": {},
119+
"path": "v1alpha1/customers:checkHasProvisionedDeployment",
120+
"response": {
121+
"$ref": "SasPortalCheckHasProvisionedDeploymentResponse"
122+
},
123+
"scopes": [
124+
"https://www.googleapis.com/auth/cloud-platform",
125+
"https://www.googleapis.com/auth/sasportal"
126+
]
127+
},
112128
"get": {
113129
"description": "Returns a requested customer.",
114130
"flatPath": "v1alpha1/customers/{customersId}",
@@ -163,6 +179,25 @@
163179
"https://www.googleapis.com/auth/sasportal"
164180
]
165181
},
182+
"migrateOrganization": {
183+
"description": "Migrates a SAS organization to the cloud. This will create GCP projects for each deployment and associate them. The SAS Organization is linked to the gcp project that called the command. go/sas-legacy-customer-migration",
184+
"flatPath": "v1alpha1/customers:migrateOrganization",
185+
"httpMethod": "POST",
186+
"id": "sasportal.customers.migrateOrganization",
187+
"parameterOrder": [],
188+
"parameters": {},
189+
"path": "v1alpha1/customers:migrateOrganization",
190+
"request": {
191+
"$ref": "SasPortalMigrateOrganizationRequest"
192+
},
193+
"response": {
194+
"$ref": "SasPortalOperation"
195+
},
196+
"scopes": [
197+
"https://www.googleapis.com/auth/cloud-platform",
198+
"https://www.googleapis.com/auth/sasportal"
199+
]
200+
},
166201
"patch": {
167202
"description": "Updates an existing customer.",
168203
"flatPath": "v1alpha1/customers/{customersId}",
@@ -2582,7 +2617,7 @@
25822617
}
25832618
}
25842619
},
2585-
"revision": "20230612",
2620+
"revision": "20230628",
25862621
"rootUrl": "https://sasportal.googleapis.com/",
25872622
"schemas": {
25882623
"SasPortalAssignment": {
@@ -2619,6 +2654,17 @@
26192654
},
26202655
"type": "object"
26212656
},
2657+
"SasPortalCheckHasProvisionedDeploymentResponse": {
2658+
"description": "Response for [CheckHasProvisionedDeployment]. [spectrum.sas.portal.v1alpha1.Provisioning.CheckHasProvisionedDeployment].",
2659+
"id": "SasPortalCheckHasProvisionedDeploymentResponse",
2660+
"properties": {
2661+
"hasProvisionedDeployment": {
2662+
"description": "Whether a SAS deployment for the authentication context exists.",
2663+
"type": "boolean"
2664+
}
2665+
},
2666+
"type": "object"
2667+
},
26222668
"SasPortalCreateSignedDeviceRequest": {
26232669
"description": "Request for CreateSignedDevice.",
26242670
"id": "SasPortalCreateSignedDeviceRequest",
@@ -2688,6 +2734,21 @@
26882734
},
26892735
"type": "object"
26902736
},
2737+
"SasPortalDeploymentAssociation": {
2738+
"description": "Association between a gcp project and a SAS user id.",
2739+
"id": "SasPortalDeploymentAssociation",
2740+
"properties": {
2741+
"gcpProjectId": {
2742+
"description": "GCP project id of the associated project.",
2743+
"type": "string"
2744+
},
2745+
"userId": {
2746+
"description": "User id of the deployment.",
2747+
"type": "string"
2748+
}
2749+
},
2750+
"type": "object"
2751+
},
26912752
"SasPortalDevice": {
26922753
"id": "SasPortalDevice",
26932754
"properties": {
@@ -3243,6 +3304,58 @@
32433304
},
32443305
"type": "object"
32453306
},
3307+
"SasPortalMigrateOrganizationMetadata": {
3308+
"description": "Long-running operation metadata message returned by the MigrateOrganization.",
3309+
"id": "SasPortalMigrateOrganizationMetadata",
3310+
"properties": {
3311+
"operationState": {
3312+
"description": "Output only. Current operation state",
3313+
"enum": [
3314+
"OPERATION_STATE_UNSPECIFIED",
3315+
"OPERATION_STATE_PENDING",
3316+
"OPERATION_STATE_RUNNING",
3317+
"OPERATION_STATE_SUCCEEDED",
3318+
"OPERATION_STATE_FAILED"
3319+
],
3320+
"enumDescriptions": [
3321+
"Unspecified.",
3322+
"Pending (Not started).",
3323+
"In-progress.",
3324+
"Done successfully.",
3325+
"Done with errors."
3326+
],
3327+
"readOnly": true,
3328+
"type": "string"
3329+
}
3330+
},
3331+
"type": "object"
3332+
},
3333+
"SasPortalMigrateOrganizationRequest": {
3334+
"description": "Request for [MigrateOrganization]. [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization]. GCP Project, Organization Info, and caller's GAIA ID should be retrieved from the RPC handler, and used to check authorization on SAS Portal organization and to create GCP Projects.",
3335+
"id": "SasPortalMigrateOrganizationRequest",
3336+
"properties": {
3337+
"organizationId": {
3338+
"description": "Required. Id of the SAS organization to be migrated.",
3339+
"format": "int64",
3340+
"type": "string"
3341+
}
3342+
},
3343+
"type": "object"
3344+
},
3345+
"SasPortalMigrateOrganizationResponse": {
3346+
"description": "Response for [MigrateOrganization]. [spectrum.sas.portal.v1alpha1.Provisioning.MigrateOrganization].",
3347+
"id": "SasPortalMigrateOrganizationResponse",
3348+
"properties": {
3349+
"deploymentAssociation": {
3350+
"description": "Optional. A list of deployment association that were created for the migration, or current associations if they already exist.",
3351+
"items": {
3352+
"$ref": "SasPortalDeploymentAssociation"
3353+
},
3354+
"type": "array"
3355+
}
3356+
},
3357+
"type": "object"
3358+
},
32463359
"SasPortalMoveDeploymentRequest": {
32473360
"description": "Request for MoveDeployment.",
32483361
"id": "SasPortalMoveDeploymentRequest",

0 commit comments

Comments
 (0)