Cloud Controls Partner API . organizations . locations . customers

close()

Close httplib2 connections.

create(parent, body=None, customerId=None, x__xgafv=None)

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"
}

delete(name, x__xgafv=None)

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); }
}

get(name, x__xgafv=None)

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"
}

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

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",
  ],
}

list_next()

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.
        

patch(name, body=None, updateMask=None, x__xgafv=None)

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"
}