Class ParameterManagerClient (2.36.0-rc)

Service describing handlers for resources.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

ParameterManagerClient(ParameterManagerClient const &)

Copy and move support

Parameter
Name	Description
	`ParameterManagerClient const &`

ParameterManagerClient(ParameterManagerClient &&)

Copy and move support

Parameter
Name	Description
	`ParameterManagerClient &&`

ParameterManagerClient(std::shared_ptr< ParameterManagerConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< ParameterManagerConnection >`
`opts`	`Options`

Operators

operator=(ParameterManagerClient const &)

Copy and move support

Parameter
Name	Description
	`ParameterManagerClient const &`

Returns
Type	Description
`ParameterManagerClient &`

operator=(ParameterManagerClient &&)

Copy and move support

Parameter
Name	Description
	`ParameterManagerClient &&`

Returns
Type	Description
`ParameterManagerClient &`

Functions

ListParameters(std::string const &, Options)

Lists Parameters in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent value for ListParametersRequest in the format `projects//locations/`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::parametermanager::v1::Parameter >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.parametermanager.v1.Parameter, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListParameters(google::cloud::parametermanager::v1::ListParametersRequest, Options)

Lists Parameters in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::parametermanager::v1::ListParametersRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.parametermanager.v1.ListParametersRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::parametermanager::v1::Parameter >

GetParameter(std::string const &, Options)

Gets details of a single Parameter.

Parameters
Name	Description
`name`	`std::string const &` Required. Name of the resource in the format `projects//locations//parameters/*`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::parametermanager::v1::Parameter >`	the result of the RPC. The response message type (google.cloud.parametermanager.v1.Parameter) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetParameter(google::cloud::parametermanager::v1::GetParameterRequest const &, Options)

Gets details of a single Parameter.

Parameters
Name	Description
`request`	`google::cloud::parametermanager::v1::GetParameterRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.parametermanager.v1.GetParameterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::parametermanager::v1::Parameter >`	the result of the RPC. The response message type (google.cloud.parametermanager.v1.Parameter) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateParameter(std::string const &, google::cloud::parametermanager::v1::Parameter const &, std::string const &, Options)

Creates a new Parameter in a given project and location.

Parameters
Name	Description
`parent`	`std::string const &` Required. Value for parent in the format `projects//locations/`.
`parameter`	`google::cloud::parametermanager::v1::Parameter const &` Required. The Parameter resource being created
`parameter_id`	`std::string const &` Required. Id of the Parameter resource
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::parametermanager::v1::Parameter >`	the result of the RPC. The response message type (google.cloud.parametermanager.v1.Parameter) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateParameter(google::cloud::parametermanager::v1::CreateParameterRequest const &, Options)

Creates a new Parameter in a given project and location.

Parameters
Name	Description
`request`	`google::cloud::parametermanager::v1::CreateParameterRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.parametermanager.v1.CreateParameterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::parametermanager::v1::Parameter >`	the result of the RPC. The response message type (google.cloud.parametermanager.v1.Parameter) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateParameter(google::cloud::parametermanager::v1::Parameter const &, google::protobuf::FieldMask const &, Options)

Updates a single Parameter.

Parameters
Name	Description
`parameter`	`google::cloud::parametermanager::v1::Parameter const &` Required. The Parameter resource being updated
`update_mask`	`google::protobuf::FieldMask const &` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::parametermanager::v1::Parameter >`	the result of the RPC. The response message type (google.cloud.parametermanager.v1.Parameter) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateParameter(google::cloud::parametermanager::v1::UpdateParameterRequest const &, Options)

Updates a single Parameter.

Parameters
Name	Description
`request`	`google::cloud::parametermanager::v1::UpdateParameterRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.parametermanager.v1.UpdateParameterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::parametermanager::v1::Parameter >`	the result of the RPC. The response message type (google.cloud.parametermanager.v1.Parameter) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteParameter(std::string const &, Options)

Deletes a single Parameter.

Parameters
Name	Description
`name`	`std::string const &` Required. Name of the resource in the format `projects//locations//parameters/*`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteParameter(google::cloud::parametermanager::v1::DeleteParameterRequest const &, Options)

Deletes a single Parameter.

Parameters
Name	Description
`request`	`google::cloud::parametermanager::v1::DeleteParameterRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.parametermanager.v1.DeleteParameterRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

ListParameterVersions(std::string const &, Options)

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

Parameters
Name	Description
`parent`	`std::string const &` Required. Parent value for ListParameterVersionsRequest in the format `projects//locations//parameters/*`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::parametermanager::v1::ParameterVersion >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.parametermanager.v1.ParameterVersion, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListParameterVersions(google::cloud::parametermanager::v1::ListParameterVersionsRequest, Options)

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

Parameters
Name	Description
`request`	`google::cloud::parametermanager::v1::ListParameterVersionsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.parametermanager.v1.ListParameterVersionsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::parametermanager::v1::ParameterVersion >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.parametermanager.v1.ParameterVersion, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetParameterVersion(std::string const &, Options)

Gets details of a single ParameterVersion.

Parameters
Name	Description
`name`	`std::string const &` Required. Name of the resource in the format `projects//locations//parameters//versions/`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::parametermanager::v1::ParameterVersion >`	the result of the RPC. The response message type (google.cloud.parametermanager.v1.ParameterVersion) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

GetParameterVersion(google::cloud::parametermanager::v1::GetParameterVersionRequest const &, Options)

Gets details of a single ParameterVersion.

Parameters
Name	Description
`request`	`google::cloud::parametermanager::v1::GetParameterVersionRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.parametermanager.v1.GetParameterVersionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::parametermanager::v1::ParameterVersion >`	the result of the RPC. The response message type (google.cloud.parametermanager.v1.ParameterVersion) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

RenderParameterVersion(std::string const &, Options)

Gets rendered version of a ParameterVersion.

Parameters
Name	Description
`name`	`std::string const &` Required. Name of the resource
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::parametermanager::v1::RenderParameterVersionResponse >`	the result of the RPC. The response message type (google.cloud.parametermanager.v1.RenderParameterVersionResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

RenderParameterVersion(google::cloud::parametermanager::v1::RenderParameterVersionRequest const &, Options)

Gets rendered version of a ParameterVersion.

Parameters
Name	Description
`request`	`google::cloud::parametermanager::v1::RenderParameterVersionRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.parametermanager.v1.RenderParameterVersionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::parametermanager::v1::RenderParameterVersionResponse >`	the result of the RPC. The response message type (google.cloud.parametermanager.v1.RenderParameterVersionResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateParameterVersion(std::string const &, google::cloud::parametermanager::v1::ParameterVersion const &, std::string const &, Options)

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

Parameters
Name	Description
`parent`	`std::string const &` Required. Value for parent in the format `projects//locations//parameters/*`.
`parameter_version`	`google::cloud::parametermanager::v1::ParameterVersion const &` Required. The ParameterVersion resource being created
`parameter_version_id`	`std::string const &` Required. Id of the ParameterVersion resource
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::parametermanager::v1::ParameterVersion >`	the result of the RPC. The response message type (google.cloud.parametermanager.v1.ParameterVersion) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

CreateParameterVersion(google::cloud::parametermanager::v1::CreateParameterVersionRequest const &, Options)

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

Parameters
Name	Description
`request`	`google::cloud::parametermanager::v1::CreateParameterVersionRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.parametermanager.v1.CreateParameterVersionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::parametermanager::v1::ParameterVersion >`	the result of the RPC. The response message type (google.cloud.parametermanager.v1.ParameterVersion) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateParameterVersion(google::cloud::parametermanager::v1::ParameterVersion const &, google::protobuf::FieldMask const &, Options)

Updates a single ParameterVersion.

Parameters
Name	Description
`parameter_version`	`google::cloud::parametermanager::v1::ParameterVersion const &` Required. The ParameterVersion resource being updated
`update_mask`	`google::protobuf::FieldMask const &` 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.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::parametermanager::v1::ParameterVersion >`	the result of the RPC. The response message type (google.cloud.parametermanager.v1.ParameterVersion) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateParameterVersion(google::cloud::parametermanager::v1::UpdateParameterVersionRequest const &, Options)

Updates a single ParameterVersion.

Parameters
Name	Description
`request`	`google::cloud::parametermanager::v1::UpdateParameterVersionRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.parametermanager.v1.UpdateParameterVersionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::parametermanager::v1::ParameterVersion >`	the result of the RPC. The response message type (google.cloud.parametermanager.v1.ParameterVersion) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteParameterVersion(std::string const &, Options)

Deletes a single ParameterVersion.

Parameters
Name	Description
`name`	`std::string const &` Required. Name of the resource in the format `projects//locations//parameters//versions/`.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

DeleteParameterVersion(google::cloud::parametermanager::v1::DeleteParameterVersionRequest const &, Options)

Deletes a single ParameterVersion.

Parameters
Name	Description
`request`	`google::cloud::parametermanager::v1::DeleteParameterVersionRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.parametermanager.v1.DeleteParameterVersionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

ListLocations(google::cloud::location::ListLocationsRequest, Options)

Lists information about the supported locations for this service.

Parameters
Name	Description
`request`	`google::cloud::location::ListLocationsRequest` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.location.ListLocationsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns

Type Description

StreamRange< google::cloud::location::Location >

a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.location.Location, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetLocation(google::cloud::location::GetLocationRequest const &, Options)

Gets information about a location.

Parameters
Name	Description
`request`	`google::cloud::location::GetLocationRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.location.GetLocationRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::location::Location >`	the result of the RPC. The response message type (google.cloud.location.Location) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.