Class DisksClient (1.3.2)

DisksClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.disks.transports.base.DisksTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

The Disks API.

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
DisksTransportThe transport used by the client instance.

Methods

DisksClient

DisksClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.disks.transports.base.DisksTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the disks client.

Parameters
NameDescription
credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

transport Union[str, DisksTransport]

The transport to use. If set to None, a transport is chosen automatically.

client_options google.api_core.client_options.ClientOptions

Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.

client_info google.api_core.gapic_v1.client_info.ClientInfo

The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf mutual TLS transport creation failed for any reason.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

add_resource_policies

add_resource_policies(request: Optional[Union[google.cloud.compute_v1.types.compute.AddResourcePoliciesDiskRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, disk: Optional[str] = None, disks_add_resource_policies_request_resource: Optional[google.cloud.compute_v1.types.compute.DisksAddResourcePoliciesRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.AddResourcePoliciesDiskRequest, dict]

The request object. A request message for Disks.AddResourcePolicies. See the method description for details.

project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

zone str

The name of the zone for this request. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

disk str

The disk name for this request. This corresponds to the disk field on the request instance; if request is provided, this should not be set.

disks_add_resource_policies_request_resource google.cloud.compute_v1.types.DisksAddResourcePoliciesRequest

The body resource for this request This corresponds to the disks_add_resource_policies_request_resource field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

add_resource_policies_unary

add_resource_policies_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.AddResourcePoliciesDiskRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, disk: Optional[str] = None, disks_add_resource_policies_request_resource: Optional[google.cloud.compute_v1.types.compute.DisksAddResourcePoliciesRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.AddResourcePoliciesDiskRequest, dict]

The request object. A request message for Disks.AddResourcePolicies. See the method description for details.

project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

zone str

The name of the zone for this request. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

disk str

The disk name for this request. This corresponds to the disk field on the request instance; if request is provided, this should not be set.

disks_add_resource_policies_request_resource google.cloud.compute_v1.types.DisksAddResourcePoliciesRequest

The body resource for this request This corresponds to the disks_add_resource_policies_request_resource field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

aggregated_list

aggregated_list(request: Optional[Union[google.cloud.compute_v1.types.compute.AggregatedListDisksRequest, dict]] = None, *, project: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Retrieves an aggregated list of persistent disks.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.AggregatedListDisksRequest, dict]

The request object. A request message for Disks.AggregatedList. See the method description for details.

project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.compute_v1.services.disks.pagers.AggregatedListPagerIterating over this object will yield results and resolve additional pages automatically.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_snapshot

create_snapshot(request: Optional[Union[google.cloud.compute_v1.types.compute.CreateSnapshotDiskRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, disk: Optional[str] = None, snapshot_resource: Optional[google.cloud.compute_v1.types.compute.Snapshot] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.CreateSnapshotDiskRequest, dict]

The request object. A request message for Disks.CreateSnapshot. See the method description for details.

project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

zone str

The name of the zone for this request. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

disk str

Name of the persistent disk to snapshot. This corresponds to the disk field on the request instance; if request is provided, this should not be set.

snapshot_resource google.cloud.compute_v1.types.Snapshot

The body resource for this request This corresponds to the snapshot_resource field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

create_snapshot_unary

create_snapshot_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.CreateSnapshotDiskRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, disk: Optional[str] = None, snapshot_resource: Optional[google.cloud.compute_v1.types.compute.Snapshot] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a snapshot of a specified persistent disk. For regular snapshot creation, consider using snapshots.insert instead, as that method supports more features, such as creating snapshots in a project different from the source disk project.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.CreateSnapshotDiskRequest, dict]

The request object. A request message for Disks.CreateSnapshot. See the method description for details.

project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

zone str

The name of the zone for this request. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

disk str

Name of the persistent disk to snapshot. This corresponds to the disk field on the request instance; if request is provided, this should not be set.

snapshot_resource google.cloud.compute_v1.types.Snapshot

The body resource for this request This corresponds to the snapshot_resource field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

delete

delete(request: Optional[Union[google.cloud.compute_v1.types.compute.DeleteDiskRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, disk: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.DeleteDiskRequest, dict]

The request object. A request message for Disks.Delete. See the method description for details.

project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

zone str

The name of the zone for this request. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

disk str

Name of the persistent disk to delete. This corresponds to the disk field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

delete_unary

delete_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.DeleteDiskRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, disk: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.DeleteDiskRequest, dict]

The request object. A request message for Disks.Delete. See the method description for details.

project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

zone str

The name of the zone for this request. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

disk str

Name of the persistent disk to delete. This corresponds to the disk field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
DisksClientThe constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
NameDescription
info dict

The service account private key info.

Returns
TypeDescription
DisksClientThe constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
DisksClientThe constructed client.

get

get(request: Optional[Union[google.cloud.compute_v1.types.compute.GetDiskRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, disk: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns a specified persistent disk. Gets a list of available persistent disks by making a list() request.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.GetDiskRequest, dict]

The request object. A request message for Disks.Get. See the method description for details.

project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

zone str

The name of the zone for this request. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

disk str

Name of the persistent disk to return. This corresponds to the disk field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.compute_v1.types.DiskRepresents a Persistent Disk resource. Google Compute Engine has two Disk resources: \* [Zonal](/compute/docs/reference/rest/v1/disks) \* [Regional](/compute/docs/reference/rest/v1/regionDisks) Persistent disks are required for running your VM instances. Create both boot and non-boot (data) persistent disks. For more information, read Persistent Disks. For more storage options, read Storage options. The disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks. The regionDisks resource represents a regional persistent disk. For more information, read Regional resources.

get_iam_policy

get_iam_policy(request: Optional[Union[google.cloud.compute_v1.types.compute.GetIamPolicyDiskRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, resource: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.GetIamPolicyDiskRequest, dict]

The request object. A request message for Disks.GetIamPolicy. See the method description for details.

project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

zone str

The name of the zone for this request. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

resource str

Name or id of the resource for this request. This corresponds to the resource field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.compute_v1.types.PolicyAn Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ],="" "etag":="" "bwwwja0yfja=", " version":="" 3="" }="" **yaml="" example:**="" bindings:="" -="" members:="" -="" user:\="" mike@example.com="" -="" group:\="" admins@example.com="" -="" domain:google.com="" -="" serviceaccount:\="" my-project-id@appspot.gserviceaccount.com="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:\="" eve@example.com="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" etag:="" bwwwja0yfja="version:" 3="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="" [iam="" documentation](\="">

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variabel is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
NameDescription
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Exceptions
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf any errors happen.
Returns
TypeDescription
Tuple[str, Callable[[], Tuple[bytes, bytes]]]returns the API endpoint and the client cert source to use.

insert

insert(request: Optional[Union[google.cloud.compute_v1.types.compute.InsertDiskRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, disk_resource: Optional[google.cloud.compute_v1.types.compute.Disk] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a persistent disk in the specified project using the data in the request. You can create a disk from a source (sourceImage, sourceSnapshot, or sourceDisk) or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.InsertDiskRequest, dict]

The request object. A request message for Disks.Insert. See the method description for details.

project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

zone str

The name of the zone for this request. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

disk_resource google.cloud.compute_v1.types.Disk

The body resource for this request This corresponds to the disk_resource field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

insert_unary

insert_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.InsertDiskRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, disk_resource: Optional[google.cloud.compute_v1.types.compute.Disk] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a persistent disk in the specified project using the data in the request. You can create a disk from a source (sourceImage, sourceSnapshot, or sourceDisk) or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.InsertDiskRequest, dict]

The request object. A request message for Disks.Insert. See the method description for details.

project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

zone str

The name of the zone for this request. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

disk_resource google.cloud.compute_v1.types.Disk

The body resource for this request This corresponds to the disk_resource field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

list

list(request: Optional[Union[google.cloud.compute_v1.types.compute.ListDisksRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Retrieves a list of persistent disks contained within the specified zone.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.ListDisksRequest, dict]

The request object. A request message for Disks.List. See the method description for details.

project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

zone str

The name of the zone for this request. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.compute_v1.services.disks.pagers.ListPagerA list of Disk resources. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

remove_resource_policies

remove_resource_policies(request: Optional[Union[google.cloud.compute_v1.types.compute.RemoveResourcePoliciesDiskRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, disk: Optional[str] = None, disks_remove_resource_policies_request_resource: Optional[google.cloud.compute_v1.types.compute.DisksRemoveResourcePoliciesRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Removes resource policies from a disk.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.RemoveResourcePoliciesDiskRequest, dict]

The request object. A request message for Disks.RemoveResourcePolicies. See the method description for details.

project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

zone str

The name of the zone for this request. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

disk str

The disk name for this request. This corresponds to the disk field on the request instance; if request is provided, this should not be set.

disks_remove_resource_policies_request_resource google.cloud.compute_v1.types.DisksRemoveResourcePoliciesRequest

The body resource for this request This corresponds to the disks_remove_resource_policies_request_resource field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

remove_resource_policies_unary

remove_resource_policies_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.RemoveResourcePoliciesDiskRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, disk: Optional[str] = None, disks_remove_resource_policies_request_resource: Optional[google.cloud.compute_v1.types.compute.DisksRemoveResourcePoliciesRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Removes resource policies from a disk.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.RemoveResourcePoliciesDiskRequest, dict]

The request object. A request message for Disks.RemoveResourcePolicies. See the method description for details.

project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

zone str

The name of the zone for this request. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

disk str

The disk name for this request. This corresponds to the disk field on the request instance; if request is provided, this should not be set.

disks_remove_resource_policies_request_resource google.cloud.compute_v1.types.DisksRemoveResourcePoliciesRequest

The body resource for this request This corresponds to the disks_remove_resource_policies_request_resource field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

resize

resize(request: Optional[Union[google.cloud.compute_v1.types.compute.ResizeDiskRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, disk: Optional[str] = None, disks_resize_request_resource: Optional[google.cloud.compute_v1.types.compute.DisksResizeRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Resizes the specified persistent disk. You can only increase the size of the disk.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.ResizeDiskRequest, dict]

The request object. A request message for Disks.Resize. See the method description for details.

project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

zone str

The name of the zone for this request. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

disk str

The name of the persistent disk. This corresponds to the disk field on the request instance; if request is provided, this should not be set.

disks_resize_request_resource google.cloud.compute_v1.types.DisksResizeRequest

The body resource for this request This corresponds to the disks_resize_request_resource field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

resize_unary

resize_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.ResizeDiskRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, disk: Optional[str] = None, disks_resize_request_resource: Optional[google.cloud.compute_v1.types.compute.DisksResizeRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Resizes the specified persistent disk. You can only increase the size of the disk.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.ResizeDiskRequest, dict]

The request object. A request message for Disks.Resize. See the method description for details.

project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

zone str

The name of the zone for this request. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

disk str

The name of the persistent disk. This corresponds to the disk field on the request instance; if request is provided, this should not be set.

disks_resize_request_resource google.cloud.compute_v1.types.DisksResizeRequest

The body resource for this request This corresponds to the disks_resize_request_resource field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

set_iam_policy

set_iam_policy(request: Optional[Union[google.cloud.compute_v1.types.compute.SetIamPolicyDiskRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, resource: Optional[str] = None, zone_set_policy_request_resource: Optional[google.cloud.compute_v1.types.compute.ZoneSetPolicyRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.SetIamPolicyDiskRequest, dict]

The request object. A request message for Disks.SetIamPolicy. See the method description for details.

project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

zone str

The name of the zone for this request. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

resource str

Name or id of the resource for this request. This corresponds to the resource field on the request instance; if request is provided, this should not be set.

zone_set_policy_request_resource google.cloud.compute_v1.types.ZoneSetPolicyRequest

The body resource for this request This corresponds to the zone_set_policy_request_resource field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.cloud.compute_v1.types.PolicyAn Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ],="" "etag":="" "bwwwja0yfja=", " version":="" 3="" }="" **yaml="" example:**="" bindings:="" -="" members:="" -="" user:\="" mike@example.com="" -="" group:\="" admins@example.com="" -="" domain:google.com="" -="" serviceaccount:\="" my-project-id@appspot.gserviceaccount.com="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:\="" eve@example.com="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" etag:="" bwwwja0yfja="version:" 3="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="" [iam="" documentation](\="">

set_labels

set_labels(request: Optional[Union[google.cloud.compute_v1.types.compute.SetLabelsDiskRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, resource: Optional[str] = None, zone_set_labels_request_resource: Optional[google.cloud.compute_v1.types.compute.ZoneSetLabelsRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.SetLabelsDiskRequest, dict]

The request object. A request message for Disks.SetLabels. See the method description for details.

project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

zone str

The name of the zone for this request. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

resource str

Name or id of the resource for this request. This corresponds to the resource field on the request instance; if request is provided, this should not be set.

zone_set_labels_request_resource google.cloud.compute_v1.types.ZoneSetLabelsRequest

The body resource for this request This corresponds to the zone_set_labels_request_resource field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

set_labels_unary

set_labels_unary(request: Optional[Union[google.cloud.compute_v1.types.compute.SetLabelsDiskRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, resource: Optional[str] = None, zone_set_labels_request_resource: Optional[google.cloud.compute_v1.types.compute.ZoneSetLabelsRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.SetLabelsDiskRequest, dict]

The request object. A request message for Disks.SetLabels. See the method description for details.

project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

zone str

The name of the zone for this request. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

resource str

Name or id of the resource for this request. This corresponds to the resource field on the request instance; if request is provided, this should not be set.

zone_set_labels_request_resource google.cloud.compute_v1.types.ZoneSetLabelsRequest

The body resource for this request This corresponds to the zone_set_labels_request_resource field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
TypeDescription
google.api_core.extended_operation.ExtendedOperationAn object representing a extended long-running operation.

test_iam_permissions

test_iam_permissions(request: Optional[Union[google.cloud.compute_v1.types.compute.TestIamPermissionsDiskRequest, dict]] = None, *, project: Optional[str] = None, zone: Optional[str] = None, resource: Optional[str] = None, test_permissions_request_resource: Optional[google.cloud.compute_v1.types.compute.TestPermissionsRequest] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns permissions that a caller has on the specified resource.

Parameters
NameDescription
request Union[google.cloud.compute_v1.types.TestIamPermissionsDiskRequest, dict]

The request object. A request message for Disks.TestIamPermissions. See the method description for details.

project str

Project ID for this request. This corresponds to the project field on the request instance; if request is provided, this should not be set.

zone str

The name of the zone for this request. This corresponds to the zone field on the request instance; if request is provided, this should not be set.

resource str

Name or id of the resource for this request. This corresponds to the resource field on the request instance; if request is provided, this should not be set.

test_permissions_request_resource google.cloud.compute_v1.types.TestPermissionsRequest

The body resource for this request This corresponds to the test_permissions_request_resource field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.