RegionDisksClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.region_disks.transports.base.RegionDisksTransport]] = 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 RegionDisks API.
Properties
transport
Returns the transport used by the client instance.
Type | Description |
RegionDisksTransport | The transport used by the client instance. |
Methods
RegionDisksClient
RegionDisksClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.region_disks.transports.base.RegionDisksTransport]] = 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 region disks client.
Name | Description |
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, RegionDisksTransport]
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 |
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 |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
add_resource_policies
add_resource_policies(request: Optional[google.cloud.compute_v1.types.compute.AddResourcePoliciesRegionDiskRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, disk: Optional[str] = None, region_disks_add_resource_policies_request_resource: Optional[google.cloud.compute_v1.types.compute.RegionDisksAddResourcePoliciesRequest] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.
Name | Description |
request |
google.cloud.compute_v1.types.AddResourcePoliciesRegionDiskRequest
The request object. A request message for RegionDisks.AddResourcePolicies. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
The name of the region for this request. This corresponds to the |
disk |
str
The disk name for this request. This corresponds to the |
region_disks_add_resource_policies_request_resource |
google.cloud.compute_v1.types.RegionDisksAddResourcePoliciesRequest
The body resource for this request This corresponds to the |
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. |
Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: - [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) \* [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) \* [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
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[google.cloud.compute_v1.types.compute.CreateSnapshotRegionDiskRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, disk: Optional[str] = None, snapshot_resource: Optional[google.cloud.compute_v1.types.compute.Snapshot] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a snapshot of this regional disk.
Name | Description |
request |
google.cloud.compute_v1.types.CreateSnapshotRegionDiskRequest
The request object. A request message for RegionDisks.CreateSnapshot. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region for this request. This corresponds to the |
disk |
str
Name of the regional persistent disk to snapshot. This corresponds to the |
snapshot_resource |
google.cloud.compute_v1.types.Snapshot
The body resource for this request This corresponds to the |
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. |
Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: - [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) \* [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) \* [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
delete
delete(request: Optional[google.cloud.compute_v1.types.compute.DeleteRegionDiskRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, disk: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of 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.
Name | Description |
request |
google.cloud.compute_v1.types.DeleteRegionDiskRequest
The request object. A request message for RegionDisks.Delete. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region for this request. This corresponds to the |
disk |
str
Name of the regional persistent disk to delete. This corresponds to the |
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. |
Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: - [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) \* [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) \* [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
RegionDisksClient | The 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.
Name | Description |
info |
dict
The service account private key info. |
Type | Description |
RegionDisksClient | The 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.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
RegionDisksClient | The constructed client. |
get
get(request: Optional[google.cloud.compute_v1.types.compute.GetRegionDiskRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, disk: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Returns a specified regional persistent disk.
Name | Description |
request |
google.cloud.compute_v1.types.GetRegionDiskRequest
The request object. A request message for RegionDisks.Get. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region for this request. This corresponds to the |
disk |
str
Name of the regional persistent disk to return. This corresponds to the |
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. |
Type | Description |
google.cloud.compute_v1.types.Disk | Represents a Persistent Disk resource. Google Compute Engine has two Disk resources: - [Zonal](/compute/docs/reference/rest/{$api_version}/disks) \* [Regional](/compute/docs/reference/rest/{$api_version}/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. (== resource_for {$api_version}.disks ==) (== resource_for {$api_version}.regionDisks ==) |
get_iam_policy
get_iam_policy(request: Optional[google.cloud.compute_v1.types.compute.GetIamPolicyRegionDiskRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, resource: Optional[str] = None, retry: google.api_core.retry.Retry = <_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.
Name | Description |
request |
google.cloud.compute_v1.types.GetIamPolicyRegionDiskRequest
The request object. A request message for RegionDisks.GetIamPolicy. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
The name of the region for this request. This corresponds to the |
resource |
str
Name or id of the resource for this request. This corresponds to the |
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. |
Type | Description |
google.cloud.compute_v1.types.Policy | An 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 to a single role. Members 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](\=""> |
insert
insert(request: Optional[google.cloud.compute_v1.types.compute.InsertRegionDiskRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, disk_resource: Optional[google.cloud.compute_v1.types.compute.Disk] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a persistent regional disk in the specified project using the data included in the request.
Name | Description |
request |
google.cloud.compute_v1.types.InsertRegionDiskRequest
The request object. A request message for RegionDisks.Insert. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region for this request. This corresponds to the |
disk_resource |
google.cloud.compute_v1.types.Disk
The body resource for this request This corresponds to the |
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. |
Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: - [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) \* [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) \* [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
list
list(request: Optional[google.cloud.compute_v1.types.compute.ListRegionDisksRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Retrieves the list of persistent disks contained within the specified region.
Name | Description |
request |
google.cloud.compute_v1.types.ListRegionDisksRequest
The request object. A request message for RegionDisks.List. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region for this request. This corresponds to the |
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. |
Type | Description |
google.cloud.compute_v1.services.region_disks.pagers.ListPager | A 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[google.cloud.compute_v1.types.compute.RemoveResourcePoliciesRegionDiskRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, disk: Optional[str] = None, region_disks_remove_resource_policies_request_resource: Optional[google.cloud.compute_v1.types.compute.RegionDisksRemoveResourcePoliciesRequest] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Removes resource policies from a regional disk.
Name | Description |
request |
google.cloud.compute_v1.types.RemoveResourcePoliciesRegionDiskRequest
The request object. A request message for RegionDisks.RemoveResourcePolicies. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
The name of the region for this request. This corresponds to the |
disk |
str
The disk name for this request. This corresponds to the |
region_disks_remove_resource_policies_request_resource |
google.cloud.compute_v1.types.RegionDisksRemoveResourcePoliciesRequest
The body resource for this request This corresponds to the |
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. |
Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: - [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) \* [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) \* [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
resize
resize(request: Optional[google.cloud.compute_v1.types.compute.ResizeRegionDiskRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, disk: Optional[str] = None, region_disks_resize_request_resource: Optional[google.cloud.compute_v1.types.compute.RegionDisksResizeRequest] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Resizes the specified regional persistent disk.
Name | Description |
request |
google.cloud.compute_v1.types.ResizeRegionDiskRequest
The request object. A request message for RegionDisks.Resize. See the method description for details. |
project |
str
The project ID for this request. This corresponds to the |
region |
str
Name of the region for this request. This corresponds to the |
disk |
str
Name of the regional persistent disk. This corresponds to the |
region_disks_resize_request_resource |
google.cloud.compute_v1.types.RegionDisksResizeRequest
The body resource for this request This corresponds to the |
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. |
Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: - [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) \* [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) \* [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
set_iam_policy
set_iam_policy(request: Optional[google.cloud.compute_v1.types.compute.SetIamPolicyRegionDiskRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, resource: Optional[str] = None, region_set_policy_request_resource: Optional[google.cloud.compute_v1.types.compute.RegionSetPolicyRequest] = None, retry: google.api_core.retry.Retry = <_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.
Name | Description |
request |
google.cloud.compute_v1.types.SetIamPolicyRegionDiskRequest
The request object. A request message for RegionDisks.SetIamPolicy. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
The name of the region for this request. This corresponds to the |
resource |
str
Name or id of the resource for this request. This corresponds to the |
region_set_policy_request_resource |
google.cloud.compute_v1.types.RegionSetPolicyRequest
The body resource for this request This corresponds to the |
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. |
Type | Description |
google.cloud.compute_v1.types.Policy | An 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 to a single role. Members 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[google.cloud.compute_v1.types.compute.SetLabelsRegionDiskRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, resource: Optional[str] = None, region_set_labels_request_resource: Optional[google.cloud.compute_v1.types.compute.RegionSetLabelsRequest] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Sets the labels on the target regional disk.
Name | Description |
request |
google.cloud.compute_v1.types.SetLabelsRegionDiskRequest
The request object. A request message for RegionDisks.SetLabels. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
The region for this request. This corresponds to the |
resource |
str
Name or id of the resource for this request. This corresponds to the |
region_set_labels_request_resource |
google.cloud.compute_v1.types.RegionSetLabelsRequest
The body resource for this request This corresponds to the |
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. |
Type | Description |
google.cloud.compute_v1.types.Operation | Represents an Operation resource. Google Compute Engine has three Operation resources: - [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) \* [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) \* [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) |
test_iam_permissions
test_iam_permissions(request: Optional[google.cloud.compute_v1.types.compute.TestIamPermissionsRegionDiskRequest] = None, *, project: Optional[str] = None, region: Optional[str] = None, resource: Optional[str] = None, test_permissions_request_resource: Optional[google.cloud.compute_v1.types.compute.TestPermissionsRequest] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Returns permissions that a caller has on the specified resource.
Name | Description |
request |
google.cloud.compute_v1.types.TestIamPermissionsRegionDiskRequest
The request object. A request message for RegionDisks.TestIamPermissions. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
The name of the region for this request. This corresponds to the |
resource |
str
Name or id of the resource for this request. This corresponds to the |
test_permissions_request_resource |
google.cloud.compute_v1.types.TestPermissionsRequest
The body resource for this request This corresponds to the |
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. |