| <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></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="cloudcontrolspartner_v1beta.organizations.locations.customers.workloads.html">workloads()</a></code> |
| </p> |
| <p class="firstline">Returns the workloads 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="#create">create(parent, body=None, customerId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a new customer.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Delete details of a single customer</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 customer</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 customers of a partner identified by its Google Cloud organization 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> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Update details of a single customer</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="create">create(parent, body=None, customerId=None, x__xgafv=None)</code> |
| <pre>Creates a new customer. |
| |
| Args: |
| parent: string, Required. Parent resource Format: `organizations/{organization}/locations/{location}` (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Contains metadata around a Cloud Controls Partner Customer |
| "customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps |
| "onboardingSteps": [ # List of customer onboarding steps |
| { # Container for customer onboarding information |
| "completionState": "A String", # Output only. Current state of the 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 |
| }, |
| ], |
| }, |
| "displayName": "A String", # Required. Display name for the customer |
| "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded |
| "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}` |
| "organizationDomain": "A String", # Output only. The customer organization domain, extracted from CRM Organization’s display_name field. e.g. "google.com" |
| } |
| |
| customerId: string, Required. The customer id to use for the customer, which will become the final component of the customer's resource name. The specified value must be a valid Google cloud organization id. |
| 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 a Cloud Controls Partner Customer |
| "customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps |
| "onboardingSteps": [ # List of customer onboarding steps |
| { # Container for customer onboarding information |
| "completionState": "A String", # Output only. Current state of the 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 |
| }, |
| ], |
| }, |
| "displayName": "A String", # Required. Display name for the customer |
| "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded |
| "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}` |
| "organizationDomain": "A String", # Output only. The customer organization domain, extracted from CRM Organization’s display_name field. e.g. "google.com" |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>Delete details of a single customer |
| |
| Args: |
| name: string, Required. name of the resource to be deleted format: name=organizations/*/locations/*/customers/* (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Gets details of a single customer |
| |
| Args: |
| name: string, Required. Format: `organizations/{organization}/locations/{location}/customers/{customer}` (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 a Cloud Controls Partner Customer |
| "customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps |
| "onboardingSteps": [ # List of customer onboarding steps |
| { # Container for customer onboarding information |
| "completionState": "A String", # Output only. Current state of the 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 |
| }, |
| ], |
| }, |
| "displayName": "A String", # Required. Display name for the customer |
| "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded |
| "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}` |
| "organizationDomain": "A String", # Output only. The customer organization domain, extracted from CRM Organization’s display_name field. e.g. "google.com" |
| }</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 customers of a partner identified by its Google Cloud organization ID |
| |
| Args: |
| parent: string, Required. Parent resource Format: `organizations/{organization}/locations/{location}` (required) |
| filter: string, Optional. Filtering results |
| orderBy: string, Optional. Hint for how to order the results |
| pageSize: integer, The maximum number of Customers to return. The service may return fewer than this value. If unspecified, at most 500 Customers will be returned. |
| pageToken: string, A page token, received from a previous `ListCustomers` 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 Customers requests |
| "customers": [ # List of customers |
| { # Contains metadata around a Cloud Controls Partner Customer |
| "customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps |
| "onboardingSteps": [ # List of customer onboarding steps |
| { # Container for customer onboarding information |
| "completionState": "A String", # Output only. Current state of the 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 |
| }, |
| ], |
| }, |
| "displayName": "A String", # Required. Display name for the customer |
| "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded |
| "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}` |
| "organizationDomain": "A String", # Output only. The customer organization domain, extracted from CRM Organization’s display_name field. e.g. "google.com" |
| }, |
| ], |
| "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", |
| ], |
| }</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> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Update details of a single customer |
| |
| Args: |
| name: string, Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}` (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Contains metadata around a Cloud Controls Partner Customer |
| "customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps |
| "onboardingSteps": [ # List of customer onboarding steps |
| { # Container for customer onboarding information |
| "completionState": "A String", # Output only. Current state of the 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 |
| }, |
| ], |
| }, |
| "displayName": "A String", # Required. Display name for the customer |
| "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded |
| "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}` |
| "organizationDomain": "A String", # Output only. The customer organization domain, extracted from CRM Organization’s display_name field. e.g. "google.com" |
| } |
| |
| updateMask: string, Optional. The list of fields to update |
| 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 a Cloud Controls Partner Customer |
| "customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps |
| "onboardingSteps": [ # List of customer onboarding steps |
| { # Container for customer onboarding information |
| "completionState": "A String", # Output only. Current state of the 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 |
| }, |
| ], |
| }, |
| "displayName": "A String", # Required. Display name for the customer |
| "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded |
| "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}` |
| "organizationDomain": "A String", # Output only. The customer organization domain, extracted from CRM Organization’s display_name field. e.g. "google.com" |
| }</pre> |
| </div> |
| |
| </body></html> |
