Package google.cloud.parametermanager.v1

Index

• ParameterManager (interface)
• CreateParameterRequest (message)
• CreateParameterVersionRequest (message)
• DeleteParameterRequest (message)
• DeleteParameterVersionRequest (message)
• GetParameterRequest (message)
• GetParameterVersionRequest (message)
• ListParameterVersionsRequest (message)
• ListParameterVersionsResponse (message)
• ListParametersRequest (message)
• ListParametersResponse (message)
• Parameter (message)
• ParameterFormat (enum)
• ParameterVersion (message)
• ParameterVersionPayload (message)
• RenderParameterVersionRequest (message)
• RenderParameterVersionResponse (message)
• UpdateParameterRequest (message)
• UpdateParameterVersionRequest (message)
• View (enum)

ParameterManager

Service describing handlers for resources

CreateParameter

rpc CreateParameter(CreateParameterRequest) returns (Parameter) Creates a new Parameter in a given project and location. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: parametermanager.parameters.create For more information, see the IAM documentation.

CreateParameterVersion

rpc CreateParameterVersion(CreateParameterVersionRequest) returns (ParameterVersion) Creates a new ParameterVersion in a given project, location, and parameter. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: parametermanager.parameterVersions.create For more information, see the IAM documentation.

DeleteParameter

rpc DeleteParameter(DeleteParameterRequest) returns (Empty) Deletes a single Parameter. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: parametermanager.parameters.delete For more information, see the IAM documentation.

DeleteParameterVersion

rpc DeleteParameterVersion(DeleteParameterVersionRequest) returns (Empty) Deletes a single ParameterVersion. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: parametermanager.parameterVersions.delete For more information, see the IAM documentation.

GetParameter

rpc GetParameter(GetParameterRequest) returns (Parameter) Gets details of a single Parameter. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: parametermanager.parameters.get For more information, see the IAM documentation.

GetParameterVersion

rpc GetParameterVersion(GetParameterVersionRequest) returns (ParameterVersion) Gets details of a single ParameterVersion. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: parametermanager.parameterVersions.get For more information, see the IAM documentation.

ListParameterVersions

rpc ListParameterVersions(ListParameterVersionsRequest) returns (ListParameterVersionsResponse) Lists ParameterVersions in a given project, location, and parameter. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: parametermanager.parameterVersions.list For more information, see the IAM documentation.

ListParameters

rpc ListParameters(ListParametersRequest) returns (ListParametersResponse) Lists Parameters in a given project and location. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: parametermanager.parameters.list For more information, see the IAM documentation.

RenderParameterVersion

rpc RenderParameterVersion(RenderParameterVersionRequest) returns (RenderParameterVersionResponse) Gets rendered version of a ParameterVersion. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: parametermanager.parameterVersions.render For more information, see the IAM documentation.

UpdateParameter

rpc UpdateParameter(UpdateParameterRequest) returns (Parameter) Updates a single Parameter. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: parametermanager.parameters.update For more information, see the IAM documentation.

UpdateParameterVersion

rpc UpdateParameterVersion(UpdateParameterVersionRequest) returns (ParameterVersion) Updates a single ParameterVersion. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: parametermanager.parameterVersions.update For more information, see the IAM documentation.

CreateParameterRequest

Message for creating a Parameter

Fields
parent	string Required. Value for parent in the format projects/*/locations/*. Authorization requires the following IAM permission on the specified resource parent: parametermanager.parameters.create
parameter_id	string Required. Id of the Parameter resource
parameter	Parameter Required. The Parameter resource being created
request_id	string Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

CreateParameterVersionRequest

Message for creating a ParameterVersion

Fields
parent	string Required. Value for parent in the format projects/*/locations/*/parameters/*. Authorization requires the following IAM permission on the specified resource parent: parametermanager.parameterVersions.create
parameter_version_id	string Required. Id of the ParameterVersion resource
parameter_version	ParameterVersion Required. The ParameterVersion resource being created
request_id	string Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

DeleteParameterRequest

Message for deleting a Parameter

Fields
name	string Required. Name of the resource in the format projects/*/locations/*/parameters/*. Authorization requires the following IAM permission on the specified resource name: parametermanager.parameters.delete
request_id	string Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

DeleteParameterVersionRequest

Message for deleting a ParameterVersion

Fields
name	string Required. Name of the resource in the format projects/*/locations/*/parameters/*/versions/*. Authorization requires the following IAM permission on the specified resource name: parametermanager.parameterVersions.delete
request_id	string Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

GetParameterRequest

Message for getting a Parameter

Fields
name	string Required. Name of the resource in the format projects/*/locations/*/parameters/*. Authorization requires the following IAM permission on the specified resource name: parametermanager.parameters.get

GetParameterVersionRequest

Message for getting a ParameterVersion

Fields
name	string Required. Name of the resource in the format projects/*/locations/*/parameters/*/versions/*. Authorization requires the following IAM permission on the specified resource name: parametermanager.parameterVersions.get
view	View Optional. View of the ParameterVersion. In the default FULL view, all metadata & payload associated with the ParameterVersion will be returned.

ListParameterVersionsRequest

Message for requesting list of ParameterVersions

Fields
parent	string Required. Parent value for ListParameterVersionsRequest in the format projects/*/locations/*/parameters/*. Authorization requires the following IAM permission on the specified resource parent: parametermanager.parameterVersions.list
page_size	int32 Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token	string Optional. A token identifying a page of results the server should return.
filter	string Optional. Filtering results
order_by	string Optional. Hint for how to order the results

ListParameterVersionsResponse

Message for response to listing ParameterVersions

Fields
parameter_versions[]	ParameterVersion The list of ParameterVersions
next_page_token	string A token identifying a page of results the server should return.
unreachable[]	string Unordered list. Locations that could not be reached.

ListParametersRequest

Message for requesting list of Parameters

Fields
parent	string Required. Parent value for ListParametersRequest in the format projects/*/locations/*. Authorization requires the following IAM permission on the specified resource parent: parametermanager.parameters.list
page_size	int32 Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
page_token	string Optional. A token identifying a page of results the server should return.
filter	string Optional. Filtering results
order_by	string Optional. Hint for how to order the results

ListParametersResponse

Message for response to listing Parameters

Fields
parameters[]	Parameter The list of Parameters
next_page_token	string A token identifying a page of results the server should return.
unreachable[]	string Unordered list. Locations that could not be reached.

Parameter

Message describing Parameter resource

Fields
name	string Identifier. [Output only] The resource name of the Parameter in the format projects/*/locations/*/parameters/*.
create_time	Timestamp Output only. [Output only] Create time stamp
update_time	Timestamp Output only. [Output only] Update time stamp
labels	map<string, string> Optional. Labels as key value pairs
format	ParameterFormat Optional. Specifies the format of a Parameter.
policy_member	ResourcePolicyMember Output only. [Output-only] policy member strings of a Google Cloud resource.

ParameterFormat

Option to specify the format of a Parameter resource (UNFORMATTED / YAML / JSON). This option is user specified at the time of creation of the resource and is immutable.

Enums
PARAMETER_FORMAT_UNSPECIFIED	The default / unset value. The API will default to the UNFORMATTED format.
UNFORMATTED	Unformatted.
YAML	YAML format.
JSON	JSON format.

ParameterVersion

Message describing ParameterVersion resource

Fields
name	string Identifier. [Output only] The resource name of the ParameterVersion in the format projects/*/locations/*/parameters/*/versions/*.
create_time	Timestamp Output only. [Output only] Create time stamp
update_time	Timestamp Output only. [Output only] Update time stamp
disabled	bool Optional. Disabled boolean to determine if a ParameterVersion acts as a metadata only resource (payload is never returned if disabled is true). If true any calls will always default to BASIC view even if the user explicitly passes FULL view as part of the request. A render call on a disabled resource fails with an error. Default value is False.
payload	ParameterVersionPayload Required. Immutable. Payload content of a ParameterVersion resource. This is only returned when the request provides the View value of FULL (default for GET request).

ParameterVersionPayload

Message for storing a ParameterVersion resource's payload data

Fields
data	bytes Required. bytes data for storing payload.

RenderParameterVersionRequest

Message for getting a ParameterVersionRender

Fields
name	string Required. Name of the resource Authorization requires the following IAM permission on the specified resource name: parametermanager.parameterVersions.render

RenderParameterVersionResponse

Message describing RenderParameterVersionResponse resource

Fields
parameter_version	string Output only. Resource identifier of a ParameterVersion in the format projects/*/locations/*/parameters/*/versions/*.
payload	ParameterVersionPayload Payload content of a ParameterVersion resource.
rendered_payload	bytes Output only. Server generated rendered version of the user provided payload data (ParameterVersionPayload) which has substitutions of all (if any) references to a SecretManager SecretVersion resources. This substituion only works for a Parameter which is in JSON or YAML format.

UpdateParameterRequest

Message for updating a Parameter

Fields
update_mask	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.
parameter	Parameter Required. The Parameter resource being updated Authorization requires the following IAM permission on the specified resource parameter: parametermanager.parameters.update
request_id	string Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

UpdateParameterVersionRequest

Message for updating a ParameterVersion

Fields
update_mask	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.
parameter_version	ParameterVersion Required. The ParameterVersion resource being updated Authorization requires the following IAM permission on the specified resource parameterVersion: parametermanager.parameterVersions.update
request_id	string Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

View

Option for requesting only metadata, or user provided payload of a ParameterVersion resource.

Enums
VIEW_UNSPECIFIED	The default / unset value. The API will default to the FULL view..
BASIC	Include only the metadata for the resource.
FULL	Include metadata & other relevant payload data as well. This is the default view.