Class ParameterManagerClient (0.1.0) 

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

Service describing handlers for resources

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

ParameterManagerClient

ParameterManagerClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.parametermanager_v1.services.parameter_manager.transports.base.ParameterManagerTransport, typing.Callable[[...], google.cloud.parametermanager_v1.services.parameter_manager.transports.base.ParameterManagerTransport]]] = 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 parameter manager 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,ParameterManagerTransport,Callable[..., ParameterManagerTransport]]]

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

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_parameter

create_parameter(
    request: typing.Optional[
        typing.Union[
            google.cloud.parametermanager_v1.types.service.CreateParameterRequest, dict
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    parameter: typing.Optional[
        google.cloud.parametermanager_v1.types.service.Parameter
    ] = None,
    parameter_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.cloud.parametermanager_v1.types.service.Parameter

Creates a new Parameter 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 parametermanager_v1

def sample_create_parameter():
    # Create a client
    client = parametermanager_v1.ParameterManagerClient()

    # Initialize request argument(s)
    request = parametermanager_v1.CreateParameterRequest(
        parent="parent_value",
        parameter_id="parameter_id_value",
    )

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

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

The request object. Message for creating a Parameter
parent str

Required. Value for parent in the format projects//locations/. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
parameter google.cloud.parametermanager_v1.types.Parameter

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

Required. Id of the Parameter resource This corresponds to the parameter_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.cloud.parametermanager_v1.types.Parameter Message describing Parameter resource

create_parameter_version

create_parameter_version(
    request: typing.Optional[
        typing.Union[
            google.cloud.parametermanager_v1.types.service.CreateParameterVersionRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    parameter_version: typing.Optional[
        google.cloud.parametermanager_v1.types.service.ParameterVersion
    ] = None,
    parameter_version_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.cloud.parametermanager_v1.types.service.ParameterVersion

Creates a new ParameterVersion in a given project, location, and parameter.

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

def sample_create_parameter_version():
    # Create a client
    client = parametermanager_v1.ParameterManagerClient()

    # Initialize request argument(s)
    parameter_version = parametermanager_v1.ParameterVersion()
    parameter_version.payload.data = b'data_blob'

    request = parametermanager_v1.CreateParameterVersionRequest(
        parent="parent_value",
        parameter_version_id="parameter_version_id_value",
        parameter_version=parameter_version,
    )

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

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

The request object. Message for creating a ParameterVersion
parent str

Required. Value for parent in the format projects//locations//parameters/*. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
parameter_version google.cloud.parametermanager_v1.types.ParameterVersion

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

Required. Id of the ParameterVersion resource This corresponds to the parameter_version_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.cloud.parametermanager_v1.types.ParameterVersion Message describing ParameterVersion resource

delete_parameter

delete_parameter(
    request: typing.Optional[
        typing.Union[
            google.cloud.parametermanager_v1.types.service.DeleteParameterRequest, 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]]] = ()
) -> None

Deletes a single Parameter.

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

def sample_delete_parameter():
    # Create a client
    client = parametermanager_v1.ParameterManagerClient()

    # Initialize request argument(s)
    request = parametermanager_v1.DeleteParameterRequest(
        name="name_value",
    )

    # Make the request
    client.delete_parameter(request=request)
Parameters
Name Description
request Union[google.cloud.parametermanager_v1.types.DeleteParameterRequest, dict]

The request object. Message for deleting a Parameter
name str

Required. Name of the resource in the format projects//locations//parameters/*. 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.

delete_parameter_version

delete_parameter_version(
    request: typing.Optional[
        typing.Union[
            google.cloud.parametermanager_v1.types.service.DeleteParameterVersionRequest,
            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]]] = ()
) -> None

Deletes a single ParameterVersion.

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

def sample_delete_parameter_version():
    # Create a client
    client = parametermanager_v1.ParameterManagerClient()

    # Initialize request argument(s)
    request = parametermanager_v1.DeleteParameterVersionRequest(
        name="name_value",
    )

    # Make the request
    client.delete_parameter_version(request=request)
Parameters
Name Description
request Union[google.cloud.parametermanager_v1.types.DeleteParameterVersionRequest, dict]

The request object. Message for deleting a ParameterVersion
name str

Required. Name of the resource in the format projects//locations//parameters//versions/. 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.

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

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_parameter

get_parameter(
    request: typing.Optional[
        typing.Union[
            google.cloud.parametermanager_v1.types.service.GetParameterRequest, 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.parametermanager_v1.types.service.Parameter

Gets details of a single Parameter.

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

def sample_get_parameter():
    # Create a client
    client = parametermanager_v1.ParameterManagerClient()

    # Initialize request argument(s)
    request = parametermanager_v1.GetParameterRequest(
        name="name_value",
    )

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

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

The request object. Message for getting a Parameter
name str

Required. Name of the resource in the format projects//locations//parameters/*. 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.parametermanager_v1.types.Parameter Message describing Parameter resource

get_parameter_version

get_parameter_version(
    request: typing.Optional[
        typing.Union[
            google.cloud.parametermanager_v1.types.service.GetParameterVersionRequest,
            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.parametermanager_v1.types.service.ParameterVersion

Gets details of a single ParameterVersion.

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

def sample_get_parameter_version():
    # Create a client
    client = parametermanager_v1.ParameterManagerClient()

    # Initialize request argument(s)
    request = parametermanager_v1.GetParameterVersionRequest(
        name="name_value",
    )

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

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

The request object. Message for getting a ParameterVersion
name str

Required. Name of the resource in the format projects//locations//parameters//versions/. 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.parametermanager_v1.types.ParameterVersion Message describing ParameterVersion resource

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_parameter_versions

list_parameter_versions(
    request: typing.Optional[
        typing.Union[
            google.cloud.parametermanager_v1.types.service.ListParameterVersionsRequest,
            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.parametermanager_v1.services.parameter_manager.pagers.ListParameterVersionsPager
)

Lists ParameterVersions in a given project, location, and parameter.

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

def sample_list_parameter_versions():
    # Create a client
    client = parametermanager_v1.ParameterManagerClient()

    # Initialize request argument(s)
    request = parametermanager_v1.ListParameterVersionsRequest(
        parent="parent_value",
    )

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

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

The request object. Message for requesting list of ParameterVersions
parent str

Required. Parent value for ListParameterVersionsRequest in the format projects//locations//parameters/*. 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.parametermanager_v1.services.parameter_manager.pagers.ListParameterVersionsPager Message for response to listing ParameterVersions Iterating over this object will yield results and resolve additional pages automatically.

list_parameters

list_parameters(
    request: typing.Optional[
        typing.Union[
            google.cloud.parametermanager_v1.types.service.ListParametersRequest, 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.parametermanager_v1.services.parameter_manager.pagers.ListParametersPager
)

Lists Parameters 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 parametermanager_v1

def sample_list_parameters():
    # Create a client
    client = parametermanager_v1.ParameterManagerClient()

    # Initialize request argument(s)
    request = parametermanager_v1.ListParametersRequest(
        parent="parent_value",
    )

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

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

The request object. Message for requesting list of Parameters
parent str

Required. Parent value for ListParametersRequest in the format projects//locations/. 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.parametermanager_v1.services.parameter_manager.pagers.ListParametersPager Message for response to listing Parameters Iterating over this object will yield results and resolve additional pages automatically.

parameter_path

parameter_path(project: str, location: str, parameter: str) -> str

Returns a fully-qualified parameter string.

parameter_version_path

parameter_version_path(
    project: str, location: str, parameter: str, parameter_version: str
) -> str

Returns a fully-qualified parameter_version 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_parameter_path

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

Parses a parameter path into its component segments.

parse_parameter_version_path

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

Parses a parameter_version path into its component segments.

render_parameter_version

render_parameter_version(
    request: typing.Optional[
        typing.Union[
            google.cloud.parametermanager_v1.types.service.RenderParameterVersionRequest,
            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.parametermanager_v1.types.service.RenderParameterVersionResponse

Gets rendered version of a ParameterVersion.

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

def sample_render_parameter_version():
    # Create a client
    client = parametermanager_v1.ParameterManagerClient()

    # Initialize request argument(s)
    request = parametermanager_v1.RenderParameterVersionRequest(
        name="name_value",
    )

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

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

The request object. Message for getting a ParameterVersionRender
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.parametermanager_v1.types.RenderParameterVersionResponse Message describing RenderParameterVersionResponse resource

update_parameter

update_parameter(
    request: typing.Optional[
        typing.Union[
            google.cloud.parametermanager_v1.types.service.UpdateParameterRequest, dict
        ]
    ] = None,
    *,
    parameter: typing.Optional[
        google.cloud.parametermanager_v1.types.service.Parameter
    ] = 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.cloud.parametermanager_v1.types.service.Parameter

Updates a single Parameter.

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

def sample_update_parameter():
    # Create a client
    client = parametermanager_v1.ParameterManagerClient()

    # Initialize request argument(s)
    request = parametermanager_v1.UpdateParameterRequest(
    )

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

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

The request object. Message for updating a Parameter
parameter google.cloud.parametermanager_v1.types.Parameter

Required. The Parameter resource being updated This corresponds to the parameter 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 Parameter resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A mutable field will be overwritten if it is in the mask. If the user does not provide a mask then all mutable fields present in the request 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.cloud.parametermanager_v1.types.Parameter Message describing Parameter resource

update_parameter_version

update_parameter_version(
    request: typing.Optional[
        typing.Union[
            google.cloud.parametermanager_v1.types.service.UpdateParameterVersionRequest,
            dict,
        ]
    ] = None,
    *,
    parameter_version: typing.Optional[
        google.cloud.parametermanager_v1.types.service.ParameterVersion
    ] = 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.cloud.parametermanager_v1.types.service.ParameterVersion

Updates a single ParameterVersion.

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

def sample_update_parameter_version():
    # Create a client
    client = parametermanager_v1.ParameterManagerClient()

    # Initialize request argument(s)
    parameter_version = parametermanager_v1.ParameterVersion()
    parameter_version.payload.data = b'data_blob'

    request = parametermanager_v1.UpdateParameterVersionRequest(
        parameter_version=parameter_version,
    )

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

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

The request object. Message for updating a ParameterVersion
parameter_version google.cloud.parametermanager_v1.types.ParameterVersion

Required. The ParameterVersion resource being updated This corresponds to the parameter_version 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 ParameterVersion resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A mutable field will be overwritten if it is in the mask. If the user does not provide a mask then all mutable fields present in the request 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.cloud.parametermanager_v1.types.ParameterVersion Message describing ParameterVersion resource