get(name, x__xgafv=None)

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

getEkmConnections(name, x__xgafv=None)

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

getPartnerPermissions(name, x__xgafv=None)

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

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

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

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.

Cloud Controls Partner API . organizations . locations . customers . workloads

Instance Methods

Method Details