GlobalPublicDelegatedPrefixesClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.global_public_delegated_prefixes.transports.base.GlobalPublicDelegatedPrefixesTransport]] = 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 GlobalPublicDelegatedPrefixes API.
Properties
transport
Returns the transport used by the client instance.
Type | Description |
GlobalPublicDelegatedPrefixesTransport | The transport used by the client instance. |
Methods
GlobalPublicDelegatedPrefixesClient
GlobalPublicDelegatedPrefixesClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.compute_v1.services.global_public_delegated_prefixes.transports.base.GlobalPublicDelegatedPrefixesTransport]] = 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 global public delegated prefixes 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, GlobalPublicDelegatedPrefixesTransport]
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. |
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.
delete
delete(request: Optional[google.cloud.compute_v1.types.compute.DeleteGlobalPublicDelegatedPrefixeRequest] = None, *, project: Optional[str] = None, public_delegated_prefix: 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 global PublicDelegatedPrefix.
Name | Description |
request |
google.cloud.compute_v1.types.DeleteGlobalPublicDelegatedPrefixeRequest
The request object. A request message for GlobalPublicDelegatedPrefixes.Delete. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
public_delegated_prefix |
str
Name of the PublicDelegatedPrefix resource 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 |
GlobalPublicDelegatedPrefixesClient | 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 |
GlobalPublicDelegatedPrefixesClient | 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 |
GlobalPublicDelegatedPrefixesClient | The constructed client. |
get
get(request: Optional[google.cloud.compute_v1.types.compute.GetGlobalPublicDelegatedPrefixeRequest] = None, *, project: Optional[str] = None, public_delegated_prefix: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Returns the specified global PublicDelegatedPrefix resource.
Name | Description |
request |
google.cloud.compute_v1.types.GetGlobalPublicDelegatedPrefixeRequest
The request object. A request message for GlobalPublicDelegatedPrefixes.Get. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
public_delegated_prefix |
str
Name of the PublicDelegatedPrefix resource 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.PublicDelegatedPrefix | A PublicDelegatedPrefix resource represents an IP block within a PublicAdvertisedPrefix that is configured within a single cloud scope (global or region). IPs in the block can be allocated to resources within that scope. Public delegated prefixes may be further broken up into smaller IP blocks in the same scope as the parent block. |
insert
insert(request: Optional[google.cloud.compute_v1.types.compute.InsertGlobalPublicDelegatedPrefixeRequest] = None, *, project: Optional[str] = None, public_delegated_prefix_resource: Optional[google.cloud.compute_v1.types.compute.PublicDelegatedPrefix] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a global PublicDelegatedPrefix in the specified project using the parameters that are included in the request.
Name | Description |
request |
google.cloud.compute_v1.types.InsertGlobalPublicDelegatedPrefixeRequest
The request object. A request message for GlobalPublicDelegatedPrefixes.Insert. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
public_delegated_prefix_resource |
google.cloud.compute_v1.types.PublicDelegatedPrefix
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.ListGlobalPublicDelegatedPrefixesRequest] = None, *, project: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Lists the global PublicDelegatedPrefixes for a project.
Name | Description |
request |
google.cloud.compute_v1.types.ListGlobalPublicDelegatedPrefixesRequest
The request object. A request message for GlobalPublicDelegatedPrefixes.List. See the method description for details. |
project |
str
Project ID 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.global_public_delegated_prefixes.pagers.ListPager | 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.
patch
patch(request: Optional[google.cloud.compute_v1.types.compute.PatchGlobalPublicDelegatedPrefixeRequest] = None, *, project: Optional[str] = None, public_delegated_prefix: Optional[str] = None, public_delegated_prefix_resource: Optional[google.cloud.compute_v1.types.compute.PublicDelegatedPrefix] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Patches the specified global PublicDelegatedPrefix resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
Name | Description |
request |
google.cloud.compute_v1.types.PatchGlobalPublicDelegatedPrefixeRequest
The request object. A request message for GlobalPublicDelegatedPrefixes.Patch. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
public_delegated_prefix |
str
Name of the PublicDelegatedPrefix resource to patch. This corresponds to the |
public_delegated_prefix_resource |
google.cloud.compute_v1.types.PublicDelegatedPrefix
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 ==) |