Class ConfigDeliveryClient (0.1.0)

ConfigDeliveryClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.configdelivery_v1alpha.services.config_delivery.transports.base.ConfigDeliveryTransport, typing.Callable[[...], google.cloud.configdelivery_v1alpha.services.config_delivery.transports.base.ConfigDeliveryTransport]]] = 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>)

ConfigDelivery service manages the deployment of kubernetes configuration to a fleet of kubernetes clusters.

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
ConfigDeliveryTransport 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

ConfigDeliveryClient

ConfigDeliveryClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.configdelivery_v1alpha.services.config_delivery.transports.base.ConfigDeliveryTransport, typing.Callable[[...], google.cloud.configdelivery_v1alpha.services.config_delivery.transports.base.ConfigDeliveryTransport]]] = 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 config delivery 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,ConfigDeliveryTransport,Callable[..., ConfigDeliveryTransport]]]

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 ConfigDeliveryTransport constructor. If set to None, a transport is chosen automatically.

client_options Optional[Union[google.api_core.client_options.ClientOptions, dict]]

Custom options for the client. 1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "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). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide a client certificate for mTLS 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. 3. The universe_domain property can be used to override the default "googleapis.com" universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.

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
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.

abort_rollout

abort_rollout(
    request: typing.Optional[
        typing.Union[
            google.cloud.configdelivery_v1alpha.types.config_delivery.AbortRolloutRequest,
            dict,
        ]
    ] = None,
    *,
    name: 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, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Abort a Rollout.

# 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 configdelivery_v1alpha

def sample_abort_rollout():
    # Create a client
    client = configdelivery_v1alpha.ConfigDeliveryClient()

    # Initialize request argument(s)
    request = configdelivery_v1alpha.AbortRolloutRequest(
        name="name_value",
    )

    # Make the request
    operation = client.abort_rollout(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.configdelivery_v1alpha.types.AbortRolloutRequest, dict]

The request object. Message for aborting a rollout.

name str

Required. Name of the Rollout. This corresponds to the name 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be Rollout Rollout resource represents an instance of FleetPackage rollout operation across a fleet. This is a system generated resource and will be read only for end-users. It will be primarily used by the service to process the changes in the FleetPackage and other changes in the environment.

cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = 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, typing.Union[str, bytes]]] = ()
) -> None

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
request .operations_pb2.CancelOperationRequest

The request object. Request message for CancelOperation method.

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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

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.

create_fleet_package

create_fleet_package(
    request: typing.Optional[
        typing.Union[
            google.cloud.configdelivery_v1alpha.types.config_delivery.CreateFleetPackageRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    fleet_package: typing.Optional[
        google.cloud.configdelivery_v1alpha.types.config_delivery.FleetPackage
    ] = None,
    fleet_package_id: 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, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Creates a new FleetPackage in a given project and location.

# 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 configdelivery_v1alpha

def sample_create_fleet_package():
    # Create a client
    client = configdelivery_v1alpha.ConfigDeliveryClient()

    # Initialize request argument(s)
    fleet_package = configdelivery_v1alpha.FleetPackage()
    fleet_package.resource_bundle_selector.resource_bundle.name = "name_value"
    fleet_package.resource_bundle_selector.resource_bundle.tag = "tag_value"
    fleet_package.variant_selector.variant_name_template = "variant_name_template_value"

    request = configdelivery_v1alpha.CreateFleetPackageRequest(
        parent="parent_value",
        fleet_package_id="fleet_package_id_value",
        fleet_package=fleet_package,
    )

    # Make the request
    operation = client.create_fleet_package(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.configdelivery_v1alpha.types.CreateFleetPackageRequest, dict]

The request object. Message for creating a FleetPackage

parent str

Required. Value for parent. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

fleet_package google.cloud.configdelivery_v1alpha.types.FleetPackage

Required. The resource being created. This corresponds to the fleet_package field on the request instance; if request is provided, this should not be set.

fleet_package_id str

Required. Id of the requesting object If auto-generating Id server-side, remove this field and fleet_package_id from the method_signature of Create RPC This corresponds to the fleet_package_id 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be FleetPackage A FleetPackage resource in the Config Delivery API. A FleetPackage defines a package through which kubernetes configuration is deployed to a fleet of kubernetes clusters.

create_release

create_release(
    request: typing.Optional[
        typing.Union[
            google.cloud.configdelivery_v1alpha.types.config_delivery.CreateReleaseRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    release: typing.Optional[
        google.cloud.configdelivery_v1alpha.types.config_delivery.Release
    ] = None,
    release_id: 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, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Creates a new Release in a given project, location and resource bundle.

# 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 configdelivery_v1alpha

def sample_create_release():
    # Create a client
    client = configdelivery_v1alpha.ConfigDeliveryClient()

    # Initialize request argument(s)
    release = configdelivery_v1alpha.Release()
    release.version = "version_value"

    request = configdelivery_v1alpha.CreateReleaseRequest(
        parent="parent_value",
        release_id="release_id_value",
        release=release,
    )

    # Make the request
    operation = client.create_release(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.configdelivery_v1alpha.types.CreateReleaseRequest, dict]

The request object. Message for creating a Release

parent str

Required. Value for parent. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

release google.cloud.configdelivery_v1alpha.types.Release

Required. The resource being created This corresponds to the release field on the request instance; if request is provided, this should not be set.

release_id str

Required. Id of the requesting object If auto-generating Id server-side, remove this field and release_id from the method_signature of Create RPC This corresponds to the release_id 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be Release Release represents a versioned release containing kubernetes manifests.

create_resource_bundle

create_resource_bundle(
    request: typing.Optional[
        typing.Union[
            google.cloud.configdelivery_v1alpha.types.config_delivery.CreateResourceBundleRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    resource_bundle: typing.Optional[
        google.cloud.configdelivery_v1alpha.types.config_delivery.ResourceBundle
    ] = None,
    resource_bundle_id: 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, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Creates a new ResourceBundle in a given project and location.

# 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 configdelivery_v1alpha

def sample_create_resource_bundle():
    # Create a client
    client = configdelivery_v1alpha.ConfigDeliveryClient()

    # Initialize request argument(s)
    request = configdelivery_v1alpha.CreateResourceBundleRequest(
        parent="parent_value",
        resource_bundle_id="resource_bundle_id_value",
    )

    # Make the request
    operation = client.create_resource_bundle(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.configdelivery_v1alpha.types.CreateResourceBundleRequest, dict]

The request object. Message for creating a ResourceBundle.

parent str

Required. Value for parent. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

resource_bundle google.cloud.configdelivery_v1alpha.types.ResourceBundle

Required. The resource being created This corresponds to the resource_bundle field on the request instance; if request is provided, this should not be set.

resource_bundle_id str

Required. Id of the requesting object If auto-generating Id server-side, remove this field and resource_bundle_id from the method_signature of Create RPC This corresponds to the resource_bundle_id 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be ResourceBundle ResourceBundle represent a collection of kubernetes configuration resources.

create_variant

create_variant(
    request: typing.Optional[
        typing.Union[
            google.cloud.configdelivery_v1alpha.types.config_delivery.CreateVariantRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    variant: typing.Optional[
        google.cloud.configdelivery_v1alpha.types.config_delivery.Variant
    ] = None,
    variant_id: 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, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Creates a new Variant in a given project, location, resource bundle, and release.

# 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 configdelivery_v1alpha

def sample_create_variant():
    # Create a client
    client = configdelivery_v1alpha.ConfigDeliveryClient()

    # Initialize request argument(s)
    variant = configdelivery_v1alpha.Variant()
    variant.resources = ['resources_value1', 'resources_value2']

    request = configdelivery_v1alpha.CreateVariantRequest(
        parent="parent_value",
        variant_id="variant_id_value",
        variant=variant,
    )

    # Make the request
    operation = client.create_variant(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.configdelivery_v1alpha.types.CreateVariantRequest, dict]

The request object. Message for creating a Variant

parent str

Required. Value for parent. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

variant google.cloud.configdelivery_v1alpha.types.Variant

Required. The resource being created This corresponds to the variant field on the request instance; if request is provided, this should not be set.

variant_id str

Required. Id of the requesting object This corresponds to the variant_id 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be Variant Variant represents the content of a ResourceBundle variant.

delete_fleet_package

delete_fleet_package(
    request: typing.Optional[
        typing.Union[
            google.cloud.configdelivery_v1alpha.types.config_delivery.DeleteFleetPackageRequest,
            dict,
        ]
    ] = None,
    *,
    name: 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, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Deletes a single FleetPackage.

# 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 configdelivery_v1alpha

def sample_delete_fleet_package():
    # Create a client
    client = configdelivery_v1alpha.ConfigDeliveryClient()

    # Initialize request argument(s)
    request = configdelivery_v1alpha.DeleteFleetPackageRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_fleet_package(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.configdelivery_v1alpha.types.DeleteFleetPackageRequest, dict]

The request object. Message for deleting a FleetPackage

name str

Required. Name of the resource This corresponds to the name 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

delete_operation

delete_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.DeleteOperationRequest
    ] = 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, typing.Union[str, bytes]]] = ()
) -> None

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
request .operations_pb2.DeleteOperationRequest

The request object. Request message for DeleteOperation method.

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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

delete_release

delete_release(
    request: typing.Optional[
        typing.Union[
            google.cloud.configdelivery_v1alpha.types.config_delivery.DeleteReleaseRequest,
            dict,
        ]
    ] = None,
    *,
    name: 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, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Deletes a single Release.

# 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 configdelivery_v1alpha

def sample_delete_release():
    # Create a client
    client = configdelivery_v1alpha.ConfigDeliveryClient()

    # Initialize request argument(s)
    request = configdelivery_v1alpha.DeleteReleaseRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_release(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.configdelivery_v1alpha.types.DeleteReleaseRequest, dict]

The request object. Message for deleting a Release

name str

Required. Name of the resource This corresponds to the name 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

delete_resource_bundle

delete_resource_bundle(
    request: typing.Optional[
        typing.Union[
            google.cloud.configdelivery_v1alpha.types.config_delivery.DeleteResourceBundleRequest,
            dict,
        ]
    ] = None,
    *,
    name: 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, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Deletes a single ResourceBundle.

# 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 configdelivery_v1alpha

def sample_delete_resource_bundle():
    # Create a client
    client = configdelivery_v1alpha.ConfigDeliveryClient()

    # Initialize request argument(s)
    request = configdelivery_v1alpha.DeleteResourceBundleRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_resource_bundle(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.configdelivery_v1alpha.types.DeleteResourceBundleRequest, dict]

The request object. Message for deleting a ResourceBundle

name str

Required. Name of the resource This corresponds to the name 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

delete_variant

delete_variant(
    request: typing.Optional[
        typing.Union[
            google.cloud.configdelivery_v1alpha.types.config_delivery.DeleteVariantRequest,
            dict,
        ]
    ] = None,
    *,
    name: 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, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Deletes a single Variant.

# 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 configdelivery_v1alpha

def sample_delete_variant():
    # Create a client
    client = configdelivery_v1alpha.ConfigDeliveryClient()

    # Initialize request argument(s)
    request = configdelivery_v1alpha.DeleteVariantRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_variant(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.configdelivery_v1alpha.types.DeleteVariantRequest, dict]

The request object. Message for deleting a Variant

name str

Required. Name of the resource This corresponds to the name 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

fleet_package_path

fleet_package_path(project: str, location: str, fleet_package: str) -> str

Returns a fully-qualified fleet_package string.

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
ConfigDeliveryClient 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
ConfigDeliveryClient 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
ConfigDeliveryClient The constructed client.

get_fleet_package

get_fleet_package(
    request: typing.Optional[
        typing.Union[
            google.cloud.configdelivery_v1alpha.types.config_delivery.GetFleetPackageRequest,
            dict,
        ]
    ] = None,
    *,
    name: 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, typing.Union[str, bytes]]] = ()
) -> google.cloud.configdelivery_v1alpha.types.config_delivery.FleetPackage

Gets details of a single FleetPackage.

# 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 configdelivery_v1alpha

def sample_get_fleet_package():
    # Create a client
    client = configdelivery_v1alpha.ConfigDeliveryClient()

    # Initialize request argument(s)
    request = configdelivery_v1alpha.GetFleetPackageRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_fleet_package(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.configdelivery_v1alpha.types.GetFleetPackageRequest, dict]

The request object. Message for getting a FleetPackage

name str

Required. Name of the resource This corresponds to the name 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type Description
google.cloud.configdelivery_v1alpha.types.FleetPackage A FleetPackage resource in the Config Delivery API. A FleetPackage defines a package through which kubernetes configuration is deployed to a fleet of kubernetes clusters.

get_location

get_location(
    request: typing.Optional[
        google.cloud.location.locations_pb2.GetLocationRequest
    ] = 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, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.Location

Gets information about a location.

Parameters
Name Description
request .location_pb2.GetLocationRequest

The request object. Request message for GetLocation method.

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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type Description
.location_pb2.Location Location object.

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 api_endpoint and client_cert_source properties may be used in this method.

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.

get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = 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, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters
Name Description
request .operations_pb2.GetOperationRequest

The request object. Request message for GetOperation method.

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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type Description
.operations_pb2.Operation An Operation object.

get_release

get_release(
    request: typing.Optional[
        typing.Union[
            google.cloud.configdelivery_v1alpha.types.config_delivery.GetReleaseRequest,
            dict,
        ]
    ] = None,
    *,
    name: 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, typing.Union[str, bytes]]] = ()
) -> google.cloud.configdelivery_v1alpha.types.config_delivery.Release

Gets details of a single Release.

# 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 configdelivery_v1alpha

def sample_get_release():
    # Create a client
    client = configdelivery_v1alpha.ConfigDeliveryClient()

    # Initialize request argument(s)
    request = configdelivery_v1alpha.GetReleaseRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_release(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.configdelivery_v1alpha.types.GetReleaseRequest, dict]

The request object. Message for getting a Release

name str

Required. Name of the resource This corresponds to the name 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type Description
google.cloud.configdelivery_v1alpha.types.Release Release represents a versioned release containing kubernetes manifests.

get_resource_bundle

get_resource_bundle(
    request: typing.Optional[
        typing.Union[
            google.cloud.configdelivery_v1alpha.types.config_delivery.GetResourceBundleRequest,
            dict,
        ]
    ] = None,
    *,
    name: 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, typing.Union[str, bytes]]] = ()
) -> google.cloud.configdelivery_v1alpha.types.config_delivery.ResourceBundle

Gets details of a single ResourceBundle.

# 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 configdelivery_v1alpha

def sample_get_resource_bundle():
    # Create a client
    client = configdelivery_v1alpha.ConfigDeliveryClient()

    # Initialize request argument(s)
    request = configdelivery_v1alpha.GetResourceBundleRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_resource_bundle(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.configdelivery_v1alpha.types.GetResourceBundleRequest, dict]

The request object. Message for getting a ResourceBundle.

name str

Required. Name of the resource. This corresponds to the name 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type Description
google.cloud.configdelivery_v1alpha.types.ResourceBundle ResourceBundle represent a collection of kubernetes configuration resources.

get_rollout

get_rollout(
    request: typing.Optional[
        typing.Union[
            google.cloud.configdelivery_v1alpha.types.config_delivery.GetRolloutRequest,
            dict,
        ]
    ] = None,
    *,
    name: 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, typing.Union[str, bytes]]] = ()
) -> google.cloud.configdelivery_v1alpha.types.config_delivery.Rollout

Gets details of a single Rollout.

# 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 configdelivery_v1alpha

def sample_get_rollout():
    # Create a client
    client = configdelivery_v1alpha.ConfigDeliveryClient()

    # Initialize request argument(s)
    request = configdelivery_v1alpha.GetRolloutRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_rollout(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.configdelivery_v1alpha.types.GetRolloutRequest, dict]

The request object. Message for getting a Rollout

name str

Required. Name of the resource This corresponds to the name 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type Description
google.cloud.configdelivery_v1alpha.types.Rollout Rollout resource represents an instance of FleetPackage rollout operation across a fleet. This is a system generated resource and will be read only for end-users. It will be primarily used by the service to process the changes in the FleetPackage and other changes in the environment.

get_variant

get_variant(
    request: typing.Optional[
        typing.Union[
            google.cloud.configdelivery_v1alpha.types.config_delivery.GetVariantRequest,
            dict,
        ]
    ] = None,
    *,
    name: 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, typing.Union[str, bytes]]] = ()
) -> google.cloud.configdelivery_v1alpha.types.config_delivery.Variant

Gets details of a single Variant.

# 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 configdelivery_v1alpha

def sample_get_variant():
    # Create a client
    client = configdelivery_v1alpha.ConfigDeliveryClient()

    # Initialize request argument(s)
    request = configdelivery_v1alpha.GetVariantRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_variant(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.configdelivery_v1alpha.types.GetVariantRequest, dict]

The request object. Message for getting a Variant

name str

Required. Name of the resource This corresponds to the name 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type Description
google.cloud.configdelivery_v1alpha.types.Variant Variant represents the content of a ResourceBundle variant.

list_fleet_packages

list_fleet_packages(
    request: typing.Optional[
        typing.Union[
            google.cloud.configdelivery_v1alpha.types.config_delivery.ListFleetPackagesRequest,
            dict,
        ]
    ] = None,
    *,
    parent: 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, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.configdelivery_v1alpha.services.config_delivery.pagers.ListFleetPackagesPager
)

Lists FleetPackages in a given project and location.

# 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 configdelivery_v1alpha

def sample_list_fleet_packages():
    # Create a client
    client = configdelivery_v1alpha.ConfigDeliveryClient()

    # Initialize request argument(s)
    request = configdelivery_v1alpha.ListFleetPackagesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_fleet_packages(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.configdelivery_v1alpha.types.ListFleetPackagesRequest, dict]

The request object. Message for requesting list of FleetPackage.

parent str

Required. Parent value for ListFleetPackagesRequest. This corresponds to the parent 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type Description
google.cloud.configdelivery_v1alpha.services.config_delivery.pagers.ListFleetPackagesPager Message for response to listing FleetPackage Iterating over this object will yield results and resolve additional pages automatically.

list_locations

list_locations(
    request: typing.Optional[
        google.cloud.location.locations_pb2.ListLocationsRequest
    ] = 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, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse

Lists information about the supported locations for this service.

Parameters
Name Description
request .location_pb2.ListLocationsRequest

The request object. Request message for ListLocations method.

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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type Description
.location_pb2.ListLocationsResponse Response message for ListLocations method.

list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = 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, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

Parameters
Name Description
request .operations_pb2.ListOperationsRequest

The request object. Request message for ListOperations method.

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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type Description
.operations_pb2.ListOperationsResponse Response message for ListOperations method.

list_releases

list_releases(
    request: typing.Optional[
        typing.Union[
            google.cloud.configdelivery_v1alpha.types.config_delivery.ListReleasesRequest,
            dict,
        ]
    ] = None,
    *,
    parent: 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, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.configdelivery_v1alpha.services.config_delivery.pagers.ListReleasesPager
)

Lists Releases in a given project and location.

# 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 configdelivery_v1alpha

def sample_list_releases():
    # Create a client
    client = configdelivery_v1alpha.ConfigDeliveryClient()

    # Initialize request argument(s)
    request = configdelivery_v1alpha.ListReleasesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_releases(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.configdelivery_v1alpha.types.ListReleasesRequest, dict]

The request object. Message for requesting list of Releases.

parent str

Required. Parent value for ListReleasesRequest. This corresponds to the parent 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type Description
google.cloud.configdelivery_v1alpha.services.config_delivery.pagers.ListReleasesPager Message for response to listing Releases Iterating over this object will yield results and resolve additional pages automatically.

list_resource_bundles

list_resource_bundles(
    request: typing.Optional[
        typing.Union[
            google.cloud.configdelivery_v1alpha.types.config_delivery.ListResourceBundlesRequest,
            dict,
        ]
    ] = None,
    *,
    parent: 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, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.configdelivery_v1alpha.services.config_delivery.pagers.ListResourceBundlesPager
)

Lists ResourceBundles in a given project and location.

# 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 configdelivery_v1alpha

def sample_list_resource_bundles():
    # Create a client
    client = configdelivery_v1alpha.ConfigDeliveryClient()

    # Initialize request argument(s)
    request = configdelivery_v1alpha.ListResourceBundlesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_resource_bundles(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.configdelivery_v1alpha.types.ListResourceBundlesRequest, dict]

The request object. Message for requesting list of ResourceBundles.

parent str

Required. Parent value for ListResourceBundlesRequest. This corresponds to the parent 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type Description
google.cloud.configdelivery_v1alpha.services.config_delivery.pagers.ListResourceBundlesPager Message for response to listing ResourceBundles. Iterating over this object will yield results and resolve additional pages automatically.

list_rollouts

list_rollouts(
    request: typing.Optional[
        typing.Union[
            google.cloud.configdelivery_v1alpha.types.config_delivery.ListRolloutsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: 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, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.configdelivery_v1alpha.services.config_delivery.pagers.ListRolloutsPager
)

Lists Rollouts in a given project, location, and Fleet Package.

# 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 configdelivery_v1alpha

def sample_list_rollouts():
    # Create a client
    client = configdelivery_v1alpha.ConfigDeliveryClient()

    # Initialize request argument(s)
    request = configdelivery_v1alpha.ListRolloutsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_rollouts(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.configdelivery_v1alpha.types.ListRolloutsRequest, dict]

The request object. Message for requesting list of Rollouts

parent str

Required. Parent value for ListRolloutsRequest This corresponds to the parent 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type Description
google.cloud.configdelivery_v1alpha.services.config_delivery.pagers.ListRolloutsPager Message for response to listing Rollouts Iterating over this object will yield results and resolve additional pages automatically.

list_variants

list_variants(
    request: typing.Optional[
        typing.Union[
            google.cloud.configdelivery_v1alpha.types.config_delivery.ListVariantsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: 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, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.configdelivery_v1alpha.services.config_delivery.pagers.ListVariantsPager
)

Lists Variants in a given project and location.

# 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 configdelivery_v1alpha

def sample_list_variants():
    # Create a client
    client = configdelivery_v1alpha.ConfigDeliveryClient()

    # Initialize request argument(s)
    request = configdelivery_v1alpha.ListVariantsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_variants(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.configdelivery_v1alpha.types.ListVariantsRequest, dict]

The request object. Message for requesting list of Variants.

parent str

Required. Parent value for ListVariantsRequest. This corresponds to the parent 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type Description
google.cloud.configdelivery_v1alpha.services.config_delivery.pagers.ListVariantsPager Message for response to listing Variants Iterating over this object will yield results and resolve additional pages automatically.

membership_path

membership_path(project: str, location: str, membership: str) -> str

Returns a fully-qualified membership string.

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.

parse_fleet_package_path

parse_fleet_package_path(path: str) -> typing.Dict[str, str]

Parses a fleet_package path into its component segments.

parse_membership_path

parse_membership_path(path: str) -> typing.Dict[str, str]

Parses a membership path into its component segments.

parse_release_path

parse_release_path(path: str) -> typing.Dict[str, str]

Parses a release path into its component segments.

parse_repository_path

parse_repository_path(path: str) -> typing.Dict[str, str]

Parses a repository path into its component segments.

parse_resource_bundle_path

parse_resource_bundle_path(path: str) -> typing.Dict[str, str]

Parses a resource_bundle path into its component segments.

parse_rollout_path

parse_rollout_path(path: str) -> typing.Dict[str, str]

Parses a rollout path into its component segments.

parse_variant_path

parse_variant_path(path: str) -> typing.Dict[str, str]

Parses a variant path into its component segments.

release_path

release_path(
    project: str, location: str, resource_bundle: str, release: str
) -> str

Returns a fully-qualified release string.

repository_path

repository_path(
    project: str, location: str, connection: str, repository: str
) -> str

Returns a fully-qualified repository string.

resource_bundle_path

resource_bundle_path(project: str, location: str, resource_bundle: str) -> str

Returns a fully-qualified resource_bundle string.

resume_rollout

resume_rollout(
    request: typing.Optional[
        typing.Union[
            google.cloud.configdelivery_v1alpha.types.config_delivery.ResumeRolloutRequest,
            dict,
        ]
    ] = None,
    *,
    name: 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, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Resume a Rollout.

# 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 configdelivery_v1alpha

def sample_resume_rollout():
    # Create a client
    client = configdelivery_v1alpha.ConfigDeliveryClient()

    # Initialize request argument(s)
    request = configdelivery_v1alpha.ResumeRolloutRequest(
        name="name_value",
    )

    # Make the request
    operation = client.resume_rollout(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.configdelivery_v1alpha.types.ResumeRolloutRequest, dict]

The request object. Message for resuming a rollout.

name str

Required. Name of the Rollout. This corresponds to the name 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be Rollout Rollout resource represents an instance of FleetPackage rollout operation across a fleet. This is a system generated resource and will be read only for end-users. It will be primarily used by the service to process the changes in the FleetPackage and other changes in the environment.

rollout_path

rollout_path(project: str, location: str, fleet_package: str, rollout: str) -> str

Returns a fully-qualified rollout string.

suspend_rollout

suspend_rollout(
    request: typing.Optional[
        typing.Union[
            google.cloud.configdelivery_v1alpha.types.config_delivery.SuspendRolloutRequest,
            dict,
        ]
    ] = None,
    *,
    name: 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, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Suspend a Rollout.

# 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 configdelivery_v1alpha

def sample_suspend_rollout():
    # Create a client
    client = configdelivery_v1alpha.ConfigDeliveryClient()

    # Initialize request argument(s)
    request = configdelivery_v1alpha.SuspendRolloutRequest(
        name="name_value",
    )

    # Make the request
    operation = client.suspend_rollout(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.configdelivery_v1alpha.types.SuspendRolloutRequest, dict]

The request object. Message for suspending a rollout.

name str

Required. Name of the Rollout. This corresponds to the name 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be Rollout Rollout resource represents an instance of FleetPackage rollout operation across a fleet. This is a system generated resource and will be read only for end-users. It will be primarily used by the service to process the changes in the FleetPackage and other changes in the environment.

update_fleet_package

update_fleet_package(
    request: typing.Optional[
        typing.Union[
            google.cloud.configdelivery_v1alpha.types.config_delivery.UpdateFleetPackageRequest,
            dict,
        ]
    ] = None,
    *,
    fleet_package: typing.Optional[
        google.cloud.configdelivery_v1alpha.types.config_delivery.FleetPackage
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = 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, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Updates the parameters of a single FleetPackage.

# 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 configdelivery_v1alpha

def sample_update_fleet_package():
    # Create a client
    client = configdelivery_v1alpha.ConfigDeliveryClient()

    # Initialize request argument(s)
    fleet_package = configdelivery_v1alpha.FleetPackage()
    fleet_package.resource_bundle_selector.resource_bundle.name = "name_value"
    fleet_package.resource_bundle_selector.resource_bundle.tag = "tag_value"
    fleet_package.variant_selector.variant_name_template = "variant_name_template_value"

    request = configdelivery_v1alpha.UpdateFleetPackageRequest(
        fleet_package=fleet_package,
    )

    # Make the request
    operation = client.update_fleet_package(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.configdelivery_v1alpha.types.UpdateFleetPackageRequest, dict]

The request object. Message for updating a FleetPackage

fleet_package google.cloud.configdelivery_v1alpha.types.FleetPackage

Required. The resource being updated This corresponds to the fleet_package field on the request instance; if request is provided, this should not be set.

update_mask google.protobuf.field_mask_pb2.FieldMask

Required. Field mask is used to specify the fields to be overwritten in the FleetPackage resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. This corresponds to the update_mask 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be FleetPackage A FleetPackage resource in the Config Delivery API. A FleetPackage defines a package through which kubernetes configuration is deployed to a fleet of kubernetes clusters.

update_release

update_release(
    request: typing.Optional[
        typing.Union[
            google.cloud.configdelivery_v1alpha.types.config_delivery.UpdateReleaseRequest,
            dict,
        ]
    ] = None,
    *,
    release: typing.Optional[
        google.cloud.configdelivery_v1alpha.types.config_delivery.Release
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = 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, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Updates the parameters of a single Release.

# 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 configdelivery_v1alpha

def sample_update_release():
    # Create a client
    client = configdelivery_v1alpha.ConfigDeliveryClient()

    # Initialize request argument(s)
    release = configdelivery_v1alpha.Release()
    release.version = "version_value"

    request = configdelivery_v1alpha.UpdateReleaseRequest(
        release=release,
    )

    # Make the request
    operation = client.update_release(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.configdelivery_v1alpha.types.UpdateReleaseRequest, dict]

The request object. Message for updating a Release

release google.cloud.configdelivery_v1alpha.types.Release

Required. The resource being updated This corresponds to the release field on the request instance; if request is provided, this should not be set.

update_mask google.protobuf.field_mask_pb2.FieldMask

Required. Field mask is used to specify the fields to be overwritten in the Release resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. This corresponds to the update_mask 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be Release Release represents a versioned release containing kubernetes manifests.

update_resource_bundle

update_resource_bundle(
    request: typing.Optional[
        typing.Union[
            google.cloud.configdelivery_v1alpha.types.config_delivery.UpdateResourceBundleRequest,
            dict,
        ]
    ] = None,
    *,
    resource_bundle: typing.Optional[
        google.cloud.configdelivery_v1alpha.types.config_delivery.ResourceBundle
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = 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, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Updates the parameters of a single ResourceBundle.

# 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 configdelivery_v1alpha

def sample_update_resource_bundle():
    # Create a client
    client = configdelivery_v1alpha.ConfigDeliveryClient()

    # Initialize request argument(s)
    request = configdelivery_v1alpha.UpdateResourceBundleRequest(
    )

    # Make the request
    operation = client.update_resource_bundle(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.configdelivery_v1alpha.types.UpdateResourceBundleRequest, dict]

The request object. Message for updating a ResourceBundle

resource_bundle google.cloud.configdelivery_v1alpha.types.ResourceBundle

Required. The resource being updated This corresponds to the resource_bundle field on the request instance; if request is provided, this should not be set.

update_mask google.protobuf.field_mask_pb2.FieldMask

Required. Field mask is used to specify the fields to be overwritten in the ResourceBundle resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. This corresponds to the update_mask 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be ResourceBundle ResourceBundle represent a collection of kubernetes configuration resources.

update_variant

update_variant(
    request: typing.Optional[
        typing.Union[
            google.cloud.configdelivery_v1alpha.types.config_delivery.UpdateVariantRequest,
            dict,
        ]
    ] = None,
    *,
    variant: typing.Optional[
        google.cloud.configdelivery_v1alpha.types.config_delivery.Variant
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = 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, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation

Updates the parameters of a single Variant.

# 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 configdelivery_v1alpha

def sample_update_variant():
    # Create a client
    client = configdelivery_v1alpha.ConfigDeliveryClient()

    # Initialize request argument(s)
    variant = configdelivery_v1alpha.Variant()
    variant.resources = ['resources_value1', 'resources_value2']

    request = configdelivery_v1alpha.UpdateVariantRequest(
        variant=variant,
    )

    # Make the request
    operation = client.update_variant(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.configdelivery_v1alpha.types.UpdateVariantRequest, dict]

The request object. Message for updating a Variant

variant google.cloud.configdelivery_v1alpha.types.Variant

Required. The resource being updated This corresponds to the variant field on the request instance; if request is provided, this should not be set.

update_mask google.protobuf.field_mask_pb2.FieldMask

Optional. Field mask is used to specify the fields to be overwritten in the Variant resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. This corresponds to the update_mask 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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.

Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be Variant Variant represents the content of a ResourceBundle variant.

variant_path

variant_path(
    project: str, location: str, resource_bundle: str, release: str, variant: str
) -> str

Returns a fully-qualified variant string.