Assured Workloads API (assuredworkloads:v1beta1)

2023-08-17

1 new method | 1 removed method

Additions

    Methods
  • assuredworkloads.organizations.locations.workloads.analyzeWorkloadMove

      Flat Path: v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:analyzeWorkloadMove

      Description: Analyzes a hypothetical move of a source resource to a target(destination) folder-based workload to surface compliance risks.

      HTTP Method: GET

      Parameter Order: target

      Path: v1beta1/{+target}:analyzeWorkloadMove

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        pageToken

          Type: string

          Location: query

          Description: Optional. The page token from the previous response. It needs to be passed in the second and following requests.

        source

          Type: string

          Deprecated: Yes

          Location: query

          Description: The source type is a project-based workload. Specify the workloads's relative resource name, formatted as: "organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}" For example: "organizations/123/locations/us-east1/workloads/assured-workload-1" This option is now deprecated.

        analyzeChildAssets

          Location: query

          Type: boolean

          Description: Optional. Indicates if all child assets of the source resource should also be analyzed in addition to the source.

        target

          Location: path

          Required: Yes

          Description: Required. The resource ID of the folder-based destination workload. This workload is where the source resource will hypothetically be moved to. Specify the workload's relative resource name, formatted as: "organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}" For example: "organizations/123/locations/us-east1/workloads/assured-workload-2"

          Type: string

          Pattern: ^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$

        pageSize

          Type: integer

          Location: query

          Format: int32

          Description: Optional. Page size. If a value is not specified, the default value of 10 is used.

        project

          Location: query

          Description: The source type is a project. Specify the project's relative resource name, formatted as either a project number or a project ID: "projects/{PROJECT_NUMBER}" or "projects/{PROJECT_ID}" For example: "projects/951040570662" when specifying a project number, or "projects/my-project-123" when specifying a project ID.

          Type: string

Deletions

    Methods
  • assuredworkloads.projects.organizations.locations.workloads.analyzeWorkloadMove

      Description: Analyzes a hypothetical move of a source resource to a target(destination) folder-based workload to surface compliance risks.

      Parameter Order:

    • project
    • target
    • Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1beta1/{+project}/{+target}:analyzeWorkloadMove

      Flat Path: v1beta1/projects/{projectsId}/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:analyzeWorkloadMove

      HTTP Method: GET

      Parameters:

        pageToken

          Description: Optional. The page token from the previous response. It needs to be passed in the second and following requests.

          Type: string

          Location: query

        source

          Location: query

          Deprecated: Yes

          Type: string

          Description: The source type is a project-based workload. Specify the workloads's relative resource name, formatted as: "organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}" For example: "organizations/123/locations/us-east1/workloads/assured-workload-1" This option is now deprecated.

        pageSize

          Type: integer

          Format: int32

          Location: query

          Description: Optional. Page size. If a value is not specified, the default value of 10 is used.

        project

          Type: string

          Location: path

          Required: Yes

          Description: The source type is a project. Specify the project's relative resource name, formatted as either a project number or a project ID: "projects/{PROJECT_NUMBER}" or "projects/{PROJECT_ID}" For example: "projects/951040570662" when specifying a project number, or "projects/my-project-123" when specifying a project ID.

          Pattern: ^projects/[^/]+$

        target

          Location: path

          Pattern: ^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$

          Description: Required. The resource ID of the folder-based destination workload. This workload is where the source resource will hypothetically be moved to. Specify the workload's relative resource name, formatted as: "organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}" For example: "organizations/123/locations/us-east1/workloads/assured-workload-2"

          Required: Yes

          Type: string

        analyzeChildAssets

          Type: boolean

          Location: query

          Description: Optional. Indicates if all child assets of the source resource should also be analyzed in addition to the source.

1 new method | 1 removed method

Additions

    Methods
  • assuredworkloads.projects.organizations.locations.workloads.analyzeWorkloadMove

      Description: Analyzes a hypothetical move of a source resource to a target(destination) folder-based workload to surface compliance risks.

      Parameter Order:

    • project
    • target
    • Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1beta1/{+project}/{+target}:analyzeWorkloadMove

      Flat Path: v1beta1/projects/{projectsId}/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:analyzeWorkloadMove

      HTTP Method: GET

      Parameters:

        pageToken

          Description: Optional. The page token from the previous response. It needs to be passed in the second and following requests.

          Type: string

          Location: query

        source

          Location: query

          Deprecated: Yes

          Type: string

          Description: The source type is a project-based workload. Specify the workloads's relative resource name, formatted as: "organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}" For example: "organizations/123/locations/us-east1/workloads/assured-workload-1" This option is now deprecated.

        pageSize

          Type: integer

          Format: int32

          Location: query

          Description: Optional. Page size. If a value is not specified, the default value of 10 is used.

        project

          Type: string

          Location: path

          Required: Yes

          Description: The source type is a project. Specify the project's relative resource name, formatted as either a project number or a project ID: "projects/{PROJECT_NUMBER}" or "projects/{PROJECT_ID}" For example: "projects/951040570662" when specifying a project number, or "projects/my-project-123" when specifying a project ID.

          Pattern: ^projects/[^/]+$

        target

          Location: path

          Pattern: ^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$

          Description: Required. The resource ID of the folder-based destination workload. This workload is where the source resource will hypothetically be moved to. Specify the workload's relative resource name, formatted as: "organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}" For example: "organizations/123/locations/us-east1/workloads/assured-workload-2"

          Required: Yes

          Type: string

        analyzeChildAssets

          Type: boolean

          Location: query

          Description: Optional. Indicates if all child assets of the source resource should also be analyzed in addition to the source.

Deletions

    Methods
  • assuredworkloads.organizations.locations.workloads.analyzeWorkloadMove

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1beta1/{+target}:analyzeWorkloadMove

      Description: Analyzes a hypothetical move of a source resource to a target(destination) folder-based workload to surface compliance risks.

      Parameters:

        analyzeChildAssets

          Location: query

          Description: Optional. Indicates if all child assets of the source resource should also be analyzed in addition to the source.

          Type: boolean

        source

          Deprecated: Yes

          Location: query

          Type: string

          Description: The source type is a project-based workload. Specify the workloads's relative resource name, formatted as: "organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}" For example: "organizations/123/locations/us-east1/workloads/assured-workload-1" This option is now deprecated.

        pageSize

          Location: query

          Type: integer

          Description: Optional. Page size. If a value is not specified, the default value of 10 is used.

          Format: int32

        project

          Description: The source type is a project. Specify the project's relative resource name, formatted as either a project number or a project ID: "projects/{PROJECT_NUMBER}" or "projects/{PROJECT_ID}" For example: "projects/951040570662" when specifying a project number, or "projects/my-project-123" when specifying a project ID.

          Type: string

          Location: query

        target

          Required: Yes

          Type: string

          Description: Required. The resource ID of the folder-based destination workload. This workload is where the source resource will hypothetically be moved to. Specify the workload's relative resource name, formatted as: "organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}" For example: "organizations/123/locations/us-east1/workloads/assured-workload-2"

          Pattern: ^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$

          Location: path

        pageToken

          Type: string

          Description: Optional. The page token from the previous response. It needs to be passed in the second and following requests.

          Location: query

      Flat Path: v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:analyzeWorkloadMove

      Parameter Order: target

      HTTP Method: GET