Cloud Build API . projects . workerPools

close()

Close httplib2 connections.

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

Creates a `WorkerPool` to run the builds, and returns the new worker pool.

Args:
  parent: string, ID of the parent project. (required)
  body: object, The request body.
    The object takes the form of:

{ # Configuration for a WorkerPool to run the builds. Workers are machines that Cloud Build uses to run your builds. By default, all workers run in a project owned by Cloud Build. To have full control over the workers that execute your builds -- such as enabling them to access private resources on your private network -- you can request Cloud Build to run the workers in your own project by creating a custom workers pool.
  "createTime": "A String", # Output only. Time at which the request to create the `WorkerPool` was received.
  "deleteTime": "A String", # Output only. Time at which the request to delete the `WorkerPool` was received.
  "name": "A String", # User-defined name of the `WorkerPool`.
  "projectId": "A String", # The project ID of the GCP project for which the `WorkerPool` is created.
  "regions": [ # List of regions to create the `WorkerPool`. Regions can't be empty. If Cloud Build adds a new GCP region in the future, the existing `WorkerPool` will not be enabled in the new region automatically; you must add the new region to the `regions` field to enable the `WorkerPool` in that region.
    "A String",
  ],
  "serviceAccountEmail": "A String", # Output only. The service account used to manage the `WorkerPool`. The service account must have the Compute Instance Admin (Beta) permission at the project level.
  "status": "A String", # Output only. WorkerPool Status.
  "updateTime": "A String", # Output only. Time at which the request to update the `WorkerPool` was received.
  "workerConfig": { # WorkerConfig defines the configuration to be used for a creating workers in the pool. # Configuration to be used for a creating workers in the `WorkerPool`.
    "diskSizeGb": "A String", # Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ If `0` is specified, Cloud Build will use a standard disk size. `disk_size` is overridden if you specify a different disk size in `build_options`. In this case, a VM with a disk size specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions
    "machineType": "A String", # Machine Type of the worker, such as n1-standard-1. See https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud Build will use a standard unspecified machine to create the worker pool. `machine_type` is overridden if you specify a different machine type in `build_options`. In this case, the VM specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/speeding-up-builds#using_custom_virtual_machine_sizes
    "network": { # Network describes the GCP network used to create workers in. # The network definition used to create the worker. If this section is left empty, the workers will be created in WorkerPool.project_id on the default network.
      "network": "A String", # Network on which the workers are created. "default" network is used if empty.
      "projectId": "A String", # Project id containing the defined network and subnetwork. For a peered VPC, this will be the same as the project_id in which the workers are created. For a shared VPC, this will be the project sharing the network with the project_id project in which workers will be created. For custom workers with no VPC, this will be the same as project_id.
      "subnetwork": "A String", # Subnetwork on which the workers are created. "default" subnetwork is used if empty.
    },
    "tag": "A String", # The tag applied to the worker, and the same tag used by the firewall rule. It is used to identify the Cloud Build workers among other VMs. The default value for tag is `worker`.
  },
  "workerCount": "A String", # Total number of workers to be created across all requested regions.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Configuration for a WorkerPool to run the builds. Workers are machines that Cloud Build uses to run your builds. By default, all workers run in a project owned by Cloud Build. To have full control over the workers that execute your builds -- such as enabling them to access private resources on your private network -- you can request Cloud Build to run the workers in your own project by creating a custom workers pool.
  "createTime": "A String", # Output only. Time at which the request to create the `WorkerPool` was received.
  "deleteTime": "A String", # Output only. Time at which the request to delete the `WorkerPool` was received.
  "name": "A String", # User-defined name of the `WorkerPool`.
  "projectId": "A String", # The project ID of the GCP project for which the `WorkerPool` is created.
  "regions": [ # List of regions to create the `WorkerPool`. Regions can't be empty. If Cloud Build adds a new GCP region in the future, the existing `WorkerPool` will not be enabled in the new region automatically; you must add the new region to the `regions` field to enable the `WorkerPool` in that region.
    "A String",
  ],
  "serviceAccountEmail": "A String", # Output only. The service account used to manage the `WorkerPool`. The service account must have the Compute Instance Admin (Beta) permission at the project level.
  "status": "A String", # Output only. WorkerPool Status.
  "updateTime": "A String", # Output only. Time at which the request to update the `WorkerPool` was received.
  "workerConfig": { # WorkerConfig defines the configuration to be used for a creating workers in the pool. # Configuration to be used for a creating workers in the `WorkerPool`.
    "diskSizeGb": "A String", # Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ If `0` is specified, Cloud Build will use a standard disk size. `disk_size` is overridden if you specify a different disk size in `build_options`. In this case, a VM with a disk size specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions
    "machineType": "A String", # Machine Type of the worker, such as n1-standard-1. See https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud Build will use a standard unspecified machine to create the worker pool. `machine_type` is overridden if you specify a different machine type in `build_options`. In this case, the VM specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/speeding-up-builds#using_custom_virtual_machine_sizes
    "network": { # Network describes the GCP network used to create workers in. # The network definition used to create the worker. If this section is left empty, the workers will be created in WorkerPool.project_id on the default network.
      "network": "A String", # Network on which the workers are created. "default" network is used if empty.
      "projectId": "A String", # Project id containing the defined network and subnetwork. For a peered VPC, this will be the same as the project_id in which the workers are created. For a shared VPC, this will be the project sharing the network with the project_id project in which workers will be created. For custom workers with no VPC, this will be the same as project_id.
      "subnetwork": "A String", # Subnetwork on which the workers are created. "default" subnetwork is used if empty.
    },
    "tag": "A String", # The tag applied to the worker, and the same tag used by the firewall rule. It is used to identify the Cloud Build workers among other VMs. The default value for tag is `worker`.
  },
  "workerCount": "A String", # Total number of workers to be created across all requested regions.
}

delete(name, x__xgafv=None)

Deletes a `WorkerPool` by its project ID and WorkerPool name.

Args:
  name: string, The field will contain name of the resource requested, for example: "projects/project-1/workerPools/workerpool-name" (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); } The JSON representation for `Empty` is empty JSON object `{}`.
}

get(name, x__xgafv=None)

Returns information about a `WorkerPool`.

Args:
  name: string, The field will contain name of the resource requested, for example: "projects/project-1/workerPools/workerpool-name" (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Configuration for a WorkerPool to run the builds. Workers are machines that Cloud Build uses to run your builds. By default, all workers run in a project owned by Cloud Build. To have full control over the workers that execute your builds -- such as enabling them to access private resources on your private network -- you can request Cloud Build to run the workers in your own project by creating a custom workers pool.
  "createTime": "A String", # Output only. Time at which the request to create the `WorkerPool` was received.
  "deleteTime": "A String", # Output only. Time at which the request to delete the `WorkerPool` was received.
  "name": "A String", # User-defined name of the `WorkerPool`.
  "projectId": "A String", # The project ID of the GCP project for which the `WorkerPool` is created.
  "regions": [ # List of regions to create the `WorkerPool`. Regions can't be empty. If Cloud Build adds a new GCP region in the future, the existing `WorkerPool` will not be enabled in the new region automatically; you must add the new region to the `regions` field to enable the `WorkerPool` in that region.
    "A String",
  ],
  "serviceAccountEmail": "A String", # Output only. The service account used to manage the `WorkerPool`. The service account must have the Compute Instance Admin (Beta) permission at the project level.
  "status": "A String", # Output only. WorkerPool Status.
  "updateTime": "A String", # Output only. Time at which the request to update the `WorkerPool` was received.
  "workerConfig": { # WorkerConfig defines the configuration to be used for a creating workers in the pool. # Configuration to be used for a creating workers in the `WorkerPool`.
    "diskSizeGb": "A String", # Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ If `0` is specified, Cloud Build will use a standard disk size. `disk_size` is overridden if you specify a different disk size in `build_options`. In this case, a VM with a disk size specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions
    "machineType": "A String", # Machine Type of the worker, such as n1-standard-1. See https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud Build will use a standard unspecified machine to create the worker pool. `machine_type` is overridden if you specify a different machine type in `build_options`. In this case, the VM specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/speeding-up-builds#using_custom_virtual_machine_sizes
    "network": { # Network describes the GCP network used to create workers in. # The network definition used to create the worker. If this section is left empty, the workers will be created in WorkerPool.project_id on the default network.
      "network": "A String", # Network on which the workers are created. "default" network is used if empty.
      "projectId": "A String", # Project id containing the defined network and subnetwork. For a peered VPC, this will be the same as the project_id in which the workers are created. For a shared VPC, this will be the project sharing the network with the project_id project in which workers will be created. For custom workers with no VPC, this will be the same as project_id.
      "subnetwork": "A String", # Subnetwork on which the workers are created. "default" subnetwork is used if empty.
    },
    "tag": "A String", # The tag applied to the worker, and the same tag used by the firewall rule. It is used to identify the Cloud Build workers among other VMs. The default value for tag is `worker`.
  },
  "workerCount": "A String", # Total number of workers to be created across all requested regions.
}

list(parent, x__xgafv=None)

List project's `WorkerPool`s.

Args:
  parent: string, ID of the parent project. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response containing existing `WorkerPools`.
  "workerPools": [ # `WorkerPools` for the project.
    { # Configuration for a WorkerPool to run the builds. Workers are machines that Cloud Build uses to run your builds. By default, all workers run in a project owned by Cloud Build. To have full control over the workers that execute your builds -- such as enabling them to access private resources on your private network -- you can request Cloud Build to run the workers in your own project by creating a custom workers pool.
      "createTime": "A String", # Output only. Time at which the request to create the `WorkerPool` was received.
      "deleteTime": "A String", # Output only. Time at which the request to delete the `WorkerPool` was received.
      "name": "A String", # User-defined name of the `WorkerPool`.
      "projectId": "A String", # The project ID of the GCP project for which the `WorkerPool` is created.
      "regions": [ # List of regions to create the `WorkerPool`. Regions can't be empty. If Cloud Build adds a new GCP region in the future, the existing `WorkerPool` will not be enabled in the new region automatically; you must add the new region to the `regions` field to enable the `WorkerPool` in that region.
        "A String",
      ],
      "serviceAccountEmail": "A String", # Output only. The service account used to manage the `WorkerPool`. The service account must have the Compute Instance Admin (Beta) permission at the project level.
      "status": "A String", # Output only. WorkerPool Status.
      "updateTime": "A String", # Output only. Time at which the request to update the `WorkerPool` was received.
      "workerConfig": { # WorkerConfig defines the configuration to be used for a creating workers in the pool. # Configuration to be used for a creating workers in the `WorkerPool`.
        "diskSizeGb": "A String", # Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ If `0` is specified, Cloud Build will use a standard disk size. `disk_size` is overridden if you specify a different disk size in `build_options`. In this case, a VM with a disk size specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions
        "machineType": "A String", # Machine Type of the worker, such as n1-standard-1. See https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud Build will use a standard unspecified machine to create the worker pool. `machine_type` is overridden if you specify a different machine type in `build_options`. In this case, the VM specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/speeding-up-builds#using_custom_virtual_machine_sizes
        "network": { # Network describes the GCP network used to create workers in. # The network definition used to create the worker. If this section is left empty, the workers will be created in WorkerPool.project_id on the default network.
          "network": "A String", # Network on which the workers are created. "default" network is used if empty.
          "projectId": "A String", # Project id containing the defined network and subnetwork. For a peered VPC, this will be the same as the project_id in which the workers are created. For a shared VPC, this will be the project sharing the network with the project_id project in which workers will be created. For custom workers with no VPC, this will be the same as project_id.
          "subnetwork": "A String", # Subnetwork on which the workers are created. "default" subnetwork is used if empty.
        },
        "tag": "A String", # The tag applied to the worker, and the same tag used by the firewall rule. It is used to identify the Cloud Build workers among other VMs. The default value for tag is `worker`.
      },
      "workerCount": "A String", # Total number of workers to be created across all requested regions.
    },
  ],
}

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

Update a `WorkerPool`.

Args:
  name: string, The field will contain name of the resource requested, for example: "projects/project-1/workerPools/workerpool-name" (required)
  body: object, The request body.
    The object takes the form of:

{ # Configuration for a WorkerPool to run the builds. Workers are machines that Cloud Build uses to run your builds. By default, all workers run in a project owned by Cloud Build. To have full control over the workers that execute your builds -- such as enabling them to access private resources on your private network -- you can request Cloud Build to run the workers in your own project by creating a custom workers pool.
  "createTime": "A String", # Output only. Time at which the request to create the `WorkerPool` was received.
  "deleteTime": "A String", # Output only. Time at which the request to delete the `WorkerPool` was received.
  "name": "A String", # User-defined name of the `WorkerPool`.
  "projectId": "A String", # The project ID of the GCP project for which the `WorkerPool` is created.
  "regions": [ # List of regions to create the `WorkerPool`. Regions can't be empty. If Cloud Build adds a new GCP region in the future, the existing `WorkerPool` will not be enabled in the new region automatically; you must add the new region to the `regions` field to enable the `WorkerPool` in that region.
    "A String",
  ],
  "serviceAccountEmail": "A String", # Output only. The service account used to manage the `WorkerPool`. The service account must have the Compute Instance Admin (Beta) permission at the project level.
  "status": "A String", # Output only. WorkerPool Status.
  "updateTime": "A String", # Output only. Time at which the request to update the `WorkerPool` was received.
  "workerConfig": { # WorkerConfig defines the configuration to be used for a creating workers in the pool. # Configuration to be used for a creating workers in the `WorkerPool`.
    "diskSizeGb": "A String", # Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ If `0` is specified, Cloud Build will use a standard disk size. `disk_size` is overridden if you specify a different disk size in `build_options`. In this case, a VM with a disk size specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions
    "machineType": "A String", # Machine Type of the worker, such as n1-standard-1. See https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud Build will use a standard unspecified machine to create the worker pool. `machine_type` is overridden if you specify a different machine type in `build_options`. In this case, the VM specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/speeding-up-builds#using_custom_virtual_machine_sizes
    "network": { # Network describes the GCP network used to create workers in. # The network definition used to create the worker. If this section is left empty, the workers will be created in WorkerPool.project_id on the default network.
      "network": "A String", # Network on which the workers are created. "default" network is used if empty.
      "projectId": "A String", # Project id containing the defined network and subnetwork. For a peered VPC, this will be the same as the project_id in which the workers are created. For a shared VPC, this will be the project sharing the network with the project_id project in which workers will be created. For custom workers with no VPC, this will be the same as project_id.
      "subnetwork": "A String", # Subnetwork on which the workers are created. "default" subnetwork is used if empty.
    },
    "tag": "A String", # The tag applied to the worker, and the same tag used by the firewall rule. It is used to identify the Cloud Build workers among other VMs. The default value for tag is `worker`.
  },
  "workerCount": "A String", # Total number of workers to be created across all requested regions.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Configuration for a WorkerPool to run the builds. Workers are machines that Cloud Build uses to run your builds. By default, all workers run in a project owned by Cloud Build. To have full control over the workers that execute your builds -- such as enabling them to access private resources on your private network -- you can request Cloud Build to run the workers in your own project by creating a custom workers pool.
  "createTime": "A String", # Output only. Time at which the request to create the `WorkerPool` was received.
  "deleteTime": "A String", # Output only. Time at which the request to delete the `WorkerPool` was received.
  "name": "A String", # User-defined name of the `WorkerPool`.
  "projectId": "A String", # The project ID of the GCP project for which the `WorkerPool` is created.
  "regions": [ # List of regions to create the `WorkerPool`. Regions can't be empty. If Cloud Build adds a new GCP region in the future, the existing `WorkerPool` will not be enabled in the new region automatically; you must add the new region to the `regions` field to enable the `WorkerPool` in that region.
    "A String",
  ],
  "serviceAccountEmail": "A String", # Output only. The service account used to manage the `WorkerPool`. The service account must have the Compute Instance Admin (Beta) permission at the project level.
  "status": "A String", # Output only. WorkerPool Status.
  "updateTime": "A String", # Output only. Time at which the request to update the `WorkerPool` was received.
  "workerConfig": { # WorkerConfig defines the configuration to be used for a creating workers in the pool. # Configuration to be used for a creating workers in the `WorkerPool`.
    "diskSizeGb": "A String", # Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ If `0` is specified, Cloud Build will use a standard disk size. `disk_size` is overridden if you specify a different disk size in `build_options`. In this case, a VM with a disk size specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions
    "machineType": "A String", # Machine Type of the worker, such as n1-standard-1. See https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud Build will use a standard unspecified machine to create the worker pool. `machine_type` is overridden if you specify a different machine type in `build_options`. In this case, the VM specified in the `build_options` will be created on demand at build time. For more information see https://cloud.google.com/cloud-build/docs/speeding-up-builds#using_custom_virtual_machine_sizes
    "network": { # Network describes the GCP network used to create workers in. # The network definition used to create the worker. If this section is left empty, the workers will be created in WorkerPool.project_id on the default network.
      "network": "A String", # Network on which the workers are created. "default" network is used if empty.
      "projectId": "A String", # Project id containing the defined network and subnetwork. For a peered VPC, this will be the same as the project_id in which the workers are created. For a shared VPC, this will be the project sharing the network with the project_id project in which workers will be created. For custom workers with no VPC, this will be the same as project_id.
      "subnetwork": "A String", # Subnetwork on which the workers are created. "default" subnetwork is used if empty.
    },
    "tag": "A String", # The tag applied to the worker, and the same tag used by the firewall rule. It is used to identify the Cloud Build workers among other VMs. The default value for tag is `worker`.
  },
  "workerCount": "A String", # Total number of workers to be created across all requested regions.
}