| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="cloudcontrolspartner_v1beta.html">Cloud Controls Partner API</a> . <a href="cloudcontrolspartner_v1beta.organizations.html">organizations</a> . <a href="cloudcontrolspartner_v1beta.organizations.locations.html">locations</a> . <a href="cloudcontrolspartner_v1beta.organizations.locations.customers.html">customers</a> . <a href="cloudcontrolspartner_v1beta.organizations.locations.customers.workloads.html">workloads</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="cloudcontrolspartner_v1beta.organizations.locations.customers.workloads.accessApprovalRequests.html">accessApprovalRequests()</a></code> |
| </p> |
| <p class="firstline">Returns the accessApprovalRequests Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="cloudcontrolspartner_v1beta.organizations.locations.customers.workloads.violations.html">violations()</a></code> |
| </p> |
| <p class="firstline">Returns the violations Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets details of a single workload</p> |
| <p class="toc_element"> |
| <code><a href="#getEkmConnections">getEkmConnections(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets the EKM connections associated with a workload</p> |
| <p class="toc_element"> |
| <code><a href="#getPartnerPermissions">getPartnerPermissions(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets the partner permissions granted for a workload</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists customer workloads for a given customer org id</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Gets details of a single workload |
| |
| Args: |
| name: string, Required. Format: `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}` (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Contains metadata around the [Workload resource](https://cloud.google.com/assured-workloads/docs/reference/rest/Shared.Types/Workload) in the Assured Workloads API. |
| "createTime": "A String", # Output only. Time the resource was created. |
| "folder": "A String", # Output only. The name of container folder of the assured workload |
| "folderId": "A String", # Output only. Folder id this workload is associated with |
| "isOnboarded": True or False, # Indicates whether a workload is fully onboarded. |
| "keyManagementProjectId": "A String", # The project id of the key management project for the workload |
| "location": "A String", # The Google Cloud location of the workload |
| "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}` |
| "partner": "A String", # Partner associated with this workload. |
| "workloadOnboardingState": { # Container for workload onboarding steps. # Container for workload onboarding steps. |
| "onboardingSteps": [ # List of workload onboarding steps. |
| { # Container for workload onboarding information. |
| "completionState": "A String", # Output only. The completion state of the onboarding step. |
| "completionTime": "A String", # The completion time of the onboarding step. |
| "startTime": "A String", # The starting time of the onboarding step. |
| "step": "A String", # The onboarding step. |
| }, |
| ], |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="getEkmConnections">getEkmConnections(name, x__xgafv=None)</code> |
| <pre>Gets the EKM connections associated with a workload |
| |
| Args: |
| name: string, Required. Format: `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections` (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # The EKM connections associated with a workload |
| "ekmConnections": [ # The EKM connections associated with the workload |
| { # Details about the EKM connection |
| "connectionError": { # Information around the error that occurred if the connection state is anything other than available or unspecified # The connection error that occurred if any |
| "errorDomain": "A String", # The error domain for the error |
| "errorMessage": "A String", # The error message for the error |
| }, |
| "connectionName": "A String", # Resource name of the EKM connection in the format: projects/{project}/locations/{location}/ekmConnections/{ekm_connection} |
| "connectionState": "A String", # Output only. The connection state |
| }, |
| ], |
| "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/ekmConnections` |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="getPartnerPermissions">getPartnerPermissions(name, x__xgafv=None)</code> |
| <pre>Gets the partner permissions granted for a workload |
| |
| Args: |
| name: string, Required. Name of the resource to get in the format: `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/partnerPermissions` (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # The permissions granted to the partner for a workload |
| "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}/partnerPermissions` |
| "partnerPermissions": [ # The partner permissions granted for the workload |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists customer workloads for a given customer org id |
| |
| Args: |
| parent: string, Required. Parent resource Format: `organizations/{organization}/locations/{location}/customers/{customer}` (required) |
| filter: string, Optional. Filtering results. |
| orderBy: string, Optional. Hint for how to order the results. |
| pageSize: integer, The maximum number of workloads to return. The service may return fewer than this value. If unspecified, at most 500 workloads will be returned. |
| pageToken: string, A page token, received from a previous `ListWorkloads` call. Provide this to retrieve the subsequent page. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for list customer workloads requests. |
| "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
| "unreachable": [ # Locations that could not be reached. |
| "A String", |
| ], |
| "workloads": [ # List of customer workloads |
| { # Contains metadata around the [Workload resource](https://cloud.google.com/assured-workloads/docs/reference/rest/Shared.Types/Workload) in the Assured Workloads API. |
| "createTime": "A String", # Output only. Time the resource was created. |
| "folder": "A String", # Output only. The name of container folder of the assured workload |
| "folderId": "A String", # Output only. Folder id this workload is associated with |
| "isOnboarded": True or False, # Indicates whether a workload is fully onboarded. |
| "keyManagementProjectId": "A String", # The project id of the key management project for the workload |
| "location": "A String", # The Google Cloud location of the workload |
| "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}/workloads/{workload}` |
| "partner": "A String", # Partner associated with this workload. |
| "workloadOnboardingState": { # Container for workload onboarding steps. # Container for workload onboarding steps. |
| "onboardingSteps": [ # List of workload onboarding steps. |
| { # Container for workload onboarding information. |
| "completionState": "A String", # Output only. The completion state of the onboarding step. |
| "completionTime": "A String", # The completion time of the onboarding step. |
| "startTime": "A String", # The starting time of the onboarding step. |
| "step": "A String", # The onboarding step. |
| }, |
| ], |
| }, |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| </body></html> |
