PublicDelegatedPrefixesClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.compute_v1.services.public_delegated_prefixes.transports.base.PublicDelegatedPrefixesTransport, typing.Callable[[...], google.cloud.compute_v1.services.public_delegated_prefixes.transports.base.PublicDelegatedPrefixesTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
The PublicDelegatedPrefixes API.
Properties
api_endpoint
Return the API endpoint used by the client instance.
Returns | |
---|---|
Type | Description |
str |
The API endpoint used by the client instance. |
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
PublicDelegatedPrefixesTransport |
The transport used by the client instance. |
universe_domain
Return the universe domain used by the client instance.
Returns | |
---|---|
Type | Description |
str |
The universe domain used by the client instance. |
Methods
PublicDelegatedPrefixesClient
PublicDelegatedPrefixesClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.compute_v1.services.public_delegated_prefixes.transports.base.PublicDelegatedPrefixesTransport, typing.Callable[[...], google.cloud.compute_v1.services.public_delegated_prefixes.transports.base.PublicDelegatedPrefixesTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the public delegated prefixes client.
Parameters | |
---|---|
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 |
Optional[Union[str,PublicDelegatedPrefixesTransport,Callable[..., PublicDelegatedPrefixesTransport]]]
The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the PublicDelegatedPrefixesTransport constructor. If set to None, a transport is chosen automatically. NOTE: "rest" transport functionality is currently in a beta state (preview). We welcome your feedback via an issue in this library's source repository. |
client_options |
Optional[Union[google.api_core.client_options.ClientOptions, dict]]
Custom options for the client. 1. The |
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 |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError |
If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
aggregated_list
aggregated_list(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.AggregatedListPublicDelegatedPrefixesRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.compute_v1.services.public_delegated_prefixes.pagers.AggregatedListPager
)
Lists all PublicDelegatedPrefix resources owned by the specific
project across all scopes. To prevent failure, Google recommends
that you set the returnPartialSuccess
parameter to true
.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1
def sample_aggregated_list():
# Create a client
client = compute_v1.PublicDelegatedPrefixesClient()
# Initialize request argument(s)
request = compute_v1.AggregatedListPublicDelegatedPrefixesRequest(
project="project_value",
)
# Make the request
page_result = client.aggregated_list(request=request)
# Handle the response
for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.AggregatedListPublicDelegatedPrefixesRequest, dict]
The request object. A request message for PublicDelegatedPrefixes.AggregatedList. See the method description for details. |
project |
str
Name of the project scoping 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. |
Returns | |
---|---|
Type | Description |
google.cloud.compute_v1.services.public_delegated_prefixes.pagers.AggregatedListPager |
Iterating over this object will yield results and resolve additional pages automatically. |
announce
announce(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.AnnouncePublicDelegatedPrefixeRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
region: typing.Optional[str] = None,
public_delegated_prefix: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation
Announces the specified PublicDelegatedPrefix in the given region.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1
def sample_announce():
# Create a client
client = compute_v1.PublicDelegatedPrefixesClient()
# Initialize request argument(s)
request = compute_v1.AnnouncePublicDelegatedPrefixeRequest(
project="project_value",
public_delegated_prefix="public_delegated_prefix_value",
region="region_value",
)
# Make the request
response = client.announce(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.AnnouncePublicDelegatedPrefixeRequest, dict]
The request object. A request message for PublicDelegatedPrefixes.Announce. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
The name of the region where the public delegated prefix is located. It should comply with RFC1035. This corresponds to the |
public_delegated_prefix |
str
The name of the public delegated prefix. It should comply with RFC1035. 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. |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation |
An object representing a extended long-running operation. |
announce_unary
announce_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.AnnouncePublicDelegatedPrefixeRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
region: typing.Optional[str] = None,
public_delegated_prefix: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation
Announces the specified PublicDelegatedPrefix in the given region.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1
def sample_announce():
# Create a client
client = compute_v1.PublicDelegatedPrefixesClient()
# Initialize request argument(s)
request = compute_v1.AnnouncePublicDelegatedPrefixeRequest(
project="project_value",
public_delegated_prefix="public_delegated_prefix_value",
region="region_value",
)
# Make the request
response = client.announce(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.AnnouncePublicDelegatedPrefixeRequest, dict]
The request object. A request message for PublicDelegatedPrefixes.Announce. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
The name of the region where the public delegated prefix is located. It should comply with RFC1035. This corresponds to the |
public_delegated_prefix |
str
The name of the public delegated prefix. It should comply with RFC1035. 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. |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation |
An object representing a extended long-running operation. |
common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
delete
delete(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.DeletePublicDelegatedPrefixeRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
region: typing.Optional[str] = None,
public_delegated_prefix: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation
Deletes the specified PublicDelegatedPrefix in the given region.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1
def sample_delete():
# Create a client
client = compute_v1.PublicDelegatedPrefixesClient()
# Initialize request argument(s)
request = compute_v1.DeletePublicDelegatedPrefixeRequest(
project="project_value",
public_delegated_prefix="public_delegated_prefix_value",
region="region_value",
)
# Make the request
response = client.delete(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.DeletePublicDelegatedPrefixeRequest, dict]
The request object. A request message for PublicDelegatedPrefixes.Delete. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region of 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. |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation |
An object representing a extended long-running operation. |
delete_unary
delete_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.DeletePublicDelegatedPrefixeRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
region: typing.Optional[str] = None,
public_delegated_prefix: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation
Deletes the specified PublicDelegatedPrefix in the given region.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1
def sample_delete():
# Create a client
client = compute_v1.PublicDelegatedPrefixesClient()
# Initialize request argument(s)
request = compute_v1.DeletePublicDelegatedPrefixeRequest(
project="project_value",
public_delegated_prefix="public_delegated_prefix_value",
region="region_value",
)
# Make the request
response = client.delete(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.DeletePublicDelegatedPrefixeRequest, dict]
The request object. A request message for PublicDelegatedPrefixes.Delete. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region of 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. |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation |
An 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 | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
PublicDelegatedPrefixesClient |
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.
Parameter | |
---|---|
Name | Description |
info |
dict
The service account private key info. |
Returns | |
---|---|
Type | Description |
PublicDelegatedPrefixesClient |
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.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
PublicDelegatedPrefixesClient |
The constructed client. |
get
get(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.GetPublicDelegatedPrefixeRequest, dict
]
] = None,
*,
project: typing.Optional[str] = None,
region: typing.Optional[str] = None,
public_delegated_prefix: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.PublicDelegatedPrefix
Returns the specified PublicDelegatedPrefix resource in the given region.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1
def sample_get():
# Create a client
client = compute_v1.PublicDelegatedPrefixesClient()
# Initialize request argument(s)
request = compute_v1.GetPublicDelegatedPrefixeRequest(
project="project_value",
public_delegated_prefix="public_delegated_prefix_value",
region="region_value",
)
# Make the request
response = client.get(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.GetPublicDelegatedPrefixeRequest, dict]
The request object. A request message for PublicDelegatedPrefixes.Get. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region of 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. |
Returns | |
---|---|
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. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated. 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 variable 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 | |
---|---|
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError |
If any errors happen. |
Returns | |
---|---|
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] |
returns the API endpoint and the client cert source to use. |
insert
insert(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.InsertPublicDelegatedPrefixeRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
region: typing.Optional[str] = None,
public_delegated_prefix_resource: typing.Optional[
google.cloud.compute_v1.types.compute.PublicDelegatedPrefix
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation
Creates a PublicDelegatedPrefix in the specified project in the given region using the parameters that are included in the request.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1
def sample_insert():
# Create a client
client = compute_v1.PublicDelegatedPrefixesClient()
# Initialize request argument(s)
request = compute_v1.InsertPublicDelegatedPrefixeRequest(
project="project_value",
region="region_value",
)
# Make the request
response = client.insert(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.InsertPublicDelegatedPrefixeRequest, dict]
The request object. A request message for PublicDelegatedPrefixes.Insert. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region of 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. |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation |
An object representing a extended long-running operation. |
insert_unary
insert_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.InsertPublicDelegatedPrefixeRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
region: typing.Optional[str] = None,
public_delegated_prefix_resource: typing.Optional[
google.cloud.compute_v1.types.compute.PublicDelegatedPrefix
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation
Creates a PublicDelegatedPrefix in the specified project in the given region using the parameters that are included in the request.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1
def sample_insert():
# Create a client
client = compute_v1.PublicDelegatedPrefixesClient()
# Initialize request argument(s)
request = compute_v1.InsertPublicDelegatedPrefixeRequest(
project="project_value",
region="region_value",
)
# Make the request
response = client.insert(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.InsertPublicDelegatedPrefixeRequest, dict]
The request object. A request message for PublicDelegatedPrefixes.Insert. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region of 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. |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation |
An object representing a extended long-running operation. |
list
list(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.ListPublicDelegatedPrefixesRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
region: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.services.public_delegated_prefixes.pagers.ListPager
Lists the PublicDelegatedPrefixes for a project in the given region.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1
def sample_list():
# Create a client
client = compute_v1.PublicDelegatedPrefixesClient()
# Initialize request argument(s)
request = compute_v1.ListPublicDelegatedPrefixesRequest(
project="project_value",
region="region_value",
)
# Make the request
page_result = client.list(request=request)
# Handle the response
for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.ListPublicDelegatedPrefixesRequest, dict]
The request object. A request message for PublicDelegatedPrefixes.List. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
Name of the region of 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. |
Returns | |
---|---|
Type | Description |
google.cloud.compute_v1.services.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) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
patch
patch(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.PatchPublicDelegatedPrefixeRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
region: typing.Optional[str] = None,
public_delegated_prefix: typing.Optional[str] = None,
public_delegated_prefix_resource: typing.Optional[
google.cloud.compute_v1.types.compute.PublicDelegatedPrefix
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation
Patches the specified PublicDelegatedPrefix resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1
def sample_patch():
# Create a client
client = compute_v1.PublicDelegatedPrefixesClient()
# Initialize request argument(s)
request = compute_v1.PatchPublicDelegatedPrefixeRequest(
project="project_value",
public_delegated_prefix="public_delegated_prefix_value",
region="region_value",
)
# Make the request
response = client.patch(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.PatchPublicDelegatedPrefixeRequest, dict]
The request object. A request message for PublicDelegatedPrefixes.Patch. 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 |
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. |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation |
An object representing a extended long-running operation. |
patch_unary
patch_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.PatchPublicDelegatedPrefixeRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
region: typing.Optional[str] = None,
public_delegated_prefix: typing.Optional[str] = None,
public_delegated_prefix_resource: typing.Optional[
google.cloud.compute_v1.types.compute.PublicDelegatedPrefix
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation
Patches the specified PublicDelegatedPrefix resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1
def sample_patch():
# Create a client
client = compute_v1.PublicDelegatedPrefixesClient()
# Initialize request argument(s)
request = compute_v1.PatchPublicDelegatedPrefixeRequest(
project="project_value",
public_delegated_prefix="public_delegated_prefix_value",
region="region_value",
)
# Make the request
response = client.patch(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.PatchPublicDelegatedPrefixeRequest, dict]
The request object. A request message for PublicDelegatedPrefixes.Patch. 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 |
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. |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation |
An object representing a extended long-running operation. |
withdraw
withdraw(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.WithdrawPublicDelegatedPrefixeRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
region: typing.Optional[str] = None,
public_delegated_prefix: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.extended_operation.ExtendedOperation
Withdraws the specified PublicDelegatedPrefix in the given region.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1
def sample_withdraw():
# Create a client
client = compute_v1.PublicDelegatedPrefixesClient()
# Initialize request argument(s)
request = compute_v1.WithdrawPublicDelegatedPrefixeRequest(
project="project_value",
public_delegated_prefix="public_delegated_prefix_value",
region="region_value",
)
# Make the request
response = client.withdraw(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.WithdrawPublicDelegatedPrefixeRequest, dict]
The request object. A request message for PublicDelegatedPrefixes.Withdraw. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
The name of the region where the public delegated prefix is located. It should comply with RFC1035. This corresponds to the |
public_delegated_prefix |
str
The name of the public delegated prefix. It should comply with RFC1035. 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. |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation |
An object representing a extended long-running operation. |
withdraw_unary
withdraw_unary(
request: typing.Optional[
typing.Union[
google.cloud.compute_v1.types.compute.WithdrawPublicDelegatedPrefixeRequest,
dict,
]
] = None,
*,
project: typing.Optional[str] = None,
region: typing.Optional[str] = None,
public_delegated_prefix: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.compute_v1.types.compute.Operation
Withdraws the specified PublicDelegatedPrefix in the given region.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import compute_v1
def sample_withdraw():
# Create a client
client = compute_v1.PublicDelegatedPrefixesClient()
# Initialize request argument(s)
request = compute_v1.WithdrawPublicDelegatedPrefixeRequest(
project="project_value",
public_delegated_prefix="public_delegated_prefix_value",
region="region_value",
)
# Make the request
response = client.withdraw(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.compute_v1.types.WithdrawPublicDelegatedPrefixeRequest, dict]
The request object. A request message for PublicDelegatedPrefixes.Withdraw. See the method description for details. |
project |
str
Project ID for this request. This corresponds to the |
region |
str
The name of the region where the public delegated prefix is located. It should comply with RFC1035. This corresponds to the |
public_delegated_prefix |
str
The name of the public delegated prefix. It should comply with RFC1035. 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. |
Returns | |
---|---|
Type | Description |
google.api_core.extended_operation.ExtendedOperation |
An object representing a extended long-running operation. |