| GitHub Repository | Product Reference |
Service Description: Service describing handlers for resources
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
ParameterName name = ParameterName.of("[PROJECT]", "[LOCATION]", "[PARAMETER]");
Parameter response = parameterManagerClient.getParameter(name);
}
Note: close() needs to be called on the ParameterManagerClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
| Method | Description | Method Variants |
|---|---|---|
ListParameters |
Lists Parameters in a given project and location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetParameter |
Gets details of a single Parameter. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateParameter |
Creates a new Parameter in a given project and location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateParameter |
Updates a single Parameter. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteParameter |
Deletes a single Parameter. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListParameterVersions |
Lists ParameterVersions in a given project, location, and parameter. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetParameterVersion |
Gets details of a single ParameterVersion. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
RenderParameterVersion |
Gets rendered version of a ParameterVersion. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateParameterVersion |
Creates a new ParameterVersion in a given project, location, and parameter. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateParameterVersion |
Updates a single ParameterVersion. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteParameterVersion |
Deletes a single ParameterVersion. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListTemplates |
Lists Templates in a given project and location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetTemplate |
Gets details of a single Template. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateTemplate |
Creates a new Template in a given project and location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateTemplate |
Updates a single Template. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteTemplate |
Deletes a single Template. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListTemplateVersions |
Lists TemplateVersions in a given project, location, and template. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetTemplateVersion |
Gets details of a single TemplateVersion. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateTemplateVersion |
Creates a new TemplateVersion in a given project, location, and template. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateTemplateVersion |
Updates a single TemplateVersion. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteTemplateVersion |
Deletes a single TemplateVersion. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
RenderTemplateVersion |
Gets rendered version of a TemplateVersion. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListLocations |
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided inthe ListLocationsRequest.name field: ***Global locations**: If For gRPC and client library implementations, the resource name ispassed as the |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetLocation |
Gets information about a location. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of ParameterManagerSettings to create(). For example:
To customize credentials:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ParameterManagerSettings parameterManagerSettings =
ParameterManagerSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ParameterManagerClient parameterManagerClient =
ParameterManagerClient.create(parameterManagerSettings);
To customize the endpoint:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ParameterManagerSettings parameterManagerSettings =
ParameterManagerSettings.newBuilder().setEndpoint(myEndpoint).build();
ParameterManagerClient parameterManagerClient =
ParameterManagerClient.create(parameterManagerSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
ParameterManagerSettings parameterManagerSettings =
ParameterManagerSettings.newHttpJsonBuilder().build();
ParameterManagerClient parameterManagerClient =
ParameterManagerClient.create(parameterManagerSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final ParameterManagerClient create()Constructs an instance of ParameterManagerClient with default settings.
| Returns | |
|---|---|
| Type | Description |
ParameterManagerClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(ParameterManagerSettings settings)
public static final ParameterManagerClient create(ParameterManagerSettings settings)Constructs an instance of ParameterManagerClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
| Parameter | |
|---|---|
| Name | Description |
settings |
ParameterManagerSettings |
| Returns | |
|---|---|
| Type | Description |
ParameterManagerClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(ParameterManagerStub stub)
public static final ParameterManagerClient create(ParameterManagerStub stub)Constructs an instance of ParameterManagerClient, using the given stub for making calls. This is for advanced usage - prefer using create(ParameterManagerSettings).
| Parameter | |
|---|---|
| Name | Description |
stub |
ParameterManagerStub |
| Returns | |
|---|---|
| Type | Description |
ParameterManagerClient |
|
Constructors
ParameterManagerClient(ParameterManagerSettings settings)
protected ParameterManagerClient(ParameterManagerSettings settings)Constructs an instance of ParameterManagerClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
| Parameter | |
|---|---|
| Name | Description |
settings |
ParameterManagerSettings |
ParameterManagerClient(ParameterManagerStub stub)
protected ParameterManagerClient(ParameterManagerStub stub)| Parameter | |
|---|---|
| Name | Description |
stub |
ParameterManagerStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)| Parameters | |
|---|---|
| Name | Description |
duration |
long |
unit |
TimeUnit |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
| Exceptions | |
|---|---|
| Type | Description |
InterruptedException |
|
close()
public final void close()createParameter(@Nullable LocationName parent, Parameter parameter, String parameterId)
public final Parameter createParameter(@Nullable LocationName parent, Parameter parameter, String parameterId)Creates a new Parameter in a given project and location.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
Parameter parameter = Parameter.newBuilder().build();
String parameterId = "parameterId1335916196";
Parameter response = parameterManagerClient.createParameter(parent, parameter, parameterId);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
@org.jspecify.annotations.Nullable com.google.cloud.parametermanager.v1.LocationNameRequired. Value for parent in the format |
parameter |
ParameterRequired. The Parameter resource being created |
parameterId |
StringRequired. Id of the Parameter resource |
| Returns | |
|---|---|
| Type | Description |
Parameter |
|
createParameter(CreateParameterRequest request)
public final Parameter createParameter(CreateParameterRequest request)Creates a new Parameter in a given project and location.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
CreateParameterRequest request =
CreateParameterRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setParameterId("parameterId1335916196")
.setParameter(Parameter.newBuilder().build())
.setRequestId("requestId693933066")
.build();
Parameter response = parameterManagerClient.createParameter(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
CreateParameterRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
Parameter |
|
createParameter(String parent, Parameter parameter, String parameterId)
public final Parameter createParameter(String parent, Parameter parameter, String parameterId)Creates a new Parameter in a given project and location.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
Parameter parameter = Parameter.newBuilder().build();
String parameterId = "parameterId1335916196";
Parameter response = parameterManagerClient.createParameter(parent, parameter, parameterId);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
StringRequired. Value for parent in the format |
parameter |
ParameterRequired. The Parameter resource being created |
parameterId |
StringRequired. Id of the Parameter resource |
| Returns | |
|---|---|
| Type | Description |
Parameter |
|
createParameterCallable()
public final UnaryCallable<CreateParameterRequest,Parameter> createParameterCallable()Creates a new Parameter in a given project and location.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
CreateParameterRequest request =
CreateParameterRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setParameterId("parameterId1335916196")
.setParameter(Parameter.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<Parameter> future =
parameterManagerClient.createParameterCallable().futureCall(request);
// Do something.
Parameter response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<CreateParameterRequest,Parameter> |
|
createParameterVersion(@Nullable ParameterName parent, ParameterVersion parameterVersion, String parameterVersionId)
public final ParameterVersion createParameterVersion(@Nullable ParameterName parent, ParameterVersion parameterVersion, String parameterVersionId)Creates a new ParameterVersion in a given project, location, and parameter.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
ParameterName parent = ParameterName.of("[PROJECT]", "[LOCATION]", "[PARAMETER]");
ParameterVersion parameterVersion = ParameterVersion.newBuilder().build();
String parameterVersionId = "parameterVersionId2070530666";
ParameterVersion response =
parameterManagerClient.createParameterVersion(
parent, parameterVersion, parameterVersionId);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
@org.jspecify.annotations.Nullable com.google.cloud.parametermanager.v1.ParameterNameRequired. Value for parent in the format
|
parameterVersion |
ParameterVersionRequired. The ParameterVersion resource being created |
parameterVersionId |
StringRequired. Id of the ParameterVersion resource |
| Returns | |
|---|---|
| Type | Description |
ParameterVersion |
|
createParameterVersion(CreateParameterVersionRequest request)
public final ParameterVersion createParameterVersion(CreateParameterVersionRequest request)Creates a new ParameterVersion in a given project, location, and parameter.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
CreateParameterVersionRequest request =
CreateParameterVersionRequest.newBuilder()
.setParent(ParameterName.of("[PROJECT]", "[LOCATION]", "[PARAMETER]").toString())
.setParameterVersionId("parameterVersionId2070530666")
.setParameterVersion(ParameterVersion.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ParameterVersion response = parameterManagerClient.createParameterVersion(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
CreateParameterVersionRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
ParameterVersion |
|
createParameterVersion(String parent, ParameterVersion parameterVersion, String parameterVersionId)
public final ParameterVersion createParameterVersion(String parent, ParameterVersion parameterVersion, String parameterVersionId)Creates a new ParameterVersion in a given project, location, and parameter.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
String parent = ParameterName.of("[PROJECT]", "[LOCATION]", "[PARAMETER]").toString();
ParameterVersion parameterVersion = ParameterVersion.newBuilder().build();
String parameterVersionId = "parameterVersionId2070530666";
ParameterVersion response =
parameterManagerClient.createParameterVersion(
parent, parameterVersion, parameterVersionId);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
StringRequired. Value for parent in the format
|
parameterVersion |
ParameterVersionRequired. The ParameterVersion resource being created |
parameterVersionId |
StringRequired. Id of the ParameterVersion resource |
| Returns | |
|---|---|
| Type | Description |
ParameterVersion |
|
createParameterVersionCallable()
public final UnaryCallable<CreateParameterVersionRequest,ParameterVersion> createParameterVersionCallable()Creates a new ParameterVersion in a given project, location, and parameter.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
CreateParameterVersionRequest request =
CreateParameterVersionRequest.newBuilder()
.setParent(ParameterName.of("[PROJECT]", "[LOCATION]", "[PARAMETER]").toString())
.setParameterVersionId("parameterVersionId2070530666")
.setParameterVersion(ParameterVersion.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<ParameterVersion> future =
parameterManagerClient.createParameterVersionCallable().futureCall(request);
// Do something.
ParameterVersion response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<CreateParameterVersionRequest,ParameterVersion> |
|
createTemplate(@Nullable LocationName parent, Template template, String templateId)
public final Template createTemplate(@Nullable LocationName parent, Template template, String templateId)Creates a new Template in a given project and location.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
Template template = Template.newBuilder().build();
String templateId = "templateId1304010549";
Template response = parameterManagerClient.createTemplate(parent, template, templateId);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
@org.jspecify.annotations.Nullable com.google.cloud.parametermanager.v1.LocationNameRequired. Value for parent in the format |
template |
TemplateRequired. The Template resource being created |
templateId |
StringRequired. Id of the Template resource |
| Returns | |
|---|---|
| Type | Description |
Template |
|
createTemplate(CreateTemplateRequest request)
public final Template createTemplate(CreateTemplateRequest request)Creates a new Template in a given project and location.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
CreateTemplateRequest request =
CreateTemplateRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setTemplateId("templateId1304010549")
.setTemplate(Template.newBuilder().build())
.setRequestId("requestId693933066")
.build();
Template response = parameterManagerClient.createTemplate(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
CreateTemplateRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
Template |
|
createTemplate(String parent, Template template, String templateId)
public final Template createTemplate(String parent, Template template, String templateId)Creates a new Template in a given project and location.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
Template template = Template.newBuilder().build();
String templateId = "templateId1304010549";
Template response = parameterManagerClient.createTemplate(parent, template, templateId);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
StringRequired. Value for parent in the format |
template |
TemplateRequired. The Template resource being created |
templateId |
StringRequired. Id of the Template resource |
| Returns | |
|---|---|
| Type | Description |
Template |
|
createTemplateCallable()
public final UnaryCallable<CreateTemplateRequest,Template> createTemplateCallable()Creates a new Template in a given project and location.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
CreateTemplateRequest request =
CreateTemplateRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setTemplateId("templateId1304010549")
.setTemplate(Template.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<Template> future =
parameterManagerClient.createTemplateCallable().futureCall(request);
// Do something.
Template response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<CreateTemplateRequest,Template> |
|
createTemplateVersion(@Nullable TemplateName parent, TemplateVersion templateVersion, String templateVersionId)
public final TemplateVersion createTemplateVersion(@Nullable TemplateName parent, TemplateVersion templateVersion, String templateVersionId)Creates a new TemplateVersion in a given project, location, and template.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
TemplateName parent = TemplateName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]");
TemplateVersion templateVersion = TemplateVersion.newBuilder().build();
String templateVersionId = "templateVersionId616434873";
TemplateVersion response =
parameterManagerClient.createTemplateVersion(parent, templateVersion, templateVersionId);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
@org.jspecify.annotations.Nullable com.google.cloud.parametermanager.v1.TemplateNameRequired. Value for parent in the format
|
templateVersion |
TemplateVersionRequired. The TemplateVersion resource being created |
templateVersionId |
StringRequired. Id of the TemplateVersion resource |
| Returns | |
|---|---|
| Type | Description |
TemplateVersion |
|
createTemplateVersion(CreateTemplateVersionRequest request)
public final TemplateVersion createTemplateVersion(CreateTemplateVersionRequest request)Creates a new TemplateVersion in a given project, location, and template.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
CreateTemplateVersionRequest request =
CreateTemplateVersionRequest.newBuilder()
.setParent(TemplateName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]").toString())
.setTemplateVersionId("templateVersionId616434873")
.setTemplateVersion(TemplateVersion.newBuilder().build())
.setRequestId("requestId693933066")
.build();
TemplateVersion response = parameterManagerClient.createTemplateVersion(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
CreateTemplateVersionRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
TemplateVersion |
|
createTemplateVersion(String parent, TemplateVersion templateVersion, String templateVersionId)
public final TemplateVersion createTemplateVersion(String parent, TemplateVersion templateVersion, String templateVersionId)Creates a new TemplateVersion in a given project, location, and template.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
String parent = TemplateName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]").toString();
TemplateVersion templateVersion = TemplateVersion.newBuilder().build();
String templateVersionId = "templateVersionId616434873";
TemplateVersion response =
parameterManagerClient.createTemplateVersion(parent, templateVersion, templateVersionId);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
StringRequired. Value for parent in the format
|
templateVersion |
TemplateVersionRequired. The TemplateVersion resource being created |
templateVersionId |
StringRequired. Id of the TemplateVersion resource |
| Returns | |
|---|---|
| Type | Description |
TemplateVersion |
|
createTemplateVersionCallable()
public final UnaryCallable<CreateTemplateVersionRequest,TemplateVersion> createTemplateVersionCallable()Creates a new TemplateVersion in a given project, location, and template.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
CreateTemplateVersionRequest request =
CreateTemplateVersionRequest.newBuilder()
.setParent(TemplateName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]").toString())
.setTemplateVersionId("templateVersionId616434873")
.setTemplateVersion(TemplateVersion.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<TemplateVersion> future =
parameterManagerClient.createTemplateVersionCallable().futureCall(request);
// Do something.
TemplateVersion response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<CreateTemplateVersionRequest,TemplateVersion> |
|
deleteParameter(@Nullable ParameterName name)
public final void deleteParameter(@Nullable ParameterName name)Deletes a single Parameter.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
ParameterName name = ParameterName.of("[PROJECT]", "[LOCATION]", "[PARAMETER]");
parameterManagerClient.deleteParameter(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
@org.jspecify.annotations.Nullable com.google.cloud.parametermanager.v1.ParameterNameRequired. Name of the resource in the format
|
deleteParameter(DeleteParameterRequest request)
public final void deleteParameter(DeleteParameterRequest request)Deletes a single Parameter.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
DeleteParameterRequest request =
DeleteParameterRequest.newBuilder()
.setName(ParameterName.of("[PROJECT]", "[LOCATION]", "[PARAMETER]").toString())
.setRequestId("requestId693933066")
.build();
parameterManagerClient.deleteParameter(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
DeleteParameterRequestThe request object containing all of the parameters for the API call. |
deleteParameter(String name)
public final void deleteParameter(String name)Deletes a single Parameter.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
String name = ParameterName.of("[PROJECT]", "[LOCATION]", "[PARAMETER]").toString();
parameterManagerClient.deleteParameter(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. Name of the resource in the format
|
deleteParameterCallable()
public final UnaryCallable<DeleteParameterRequest,Empty> deleteParameterCallable()Deletes a single Parameter.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
DeleteParameterRequest request =
DeleteParameterRequest.newBuilder()
.setName(ParameterName.of("[PROJECT]", "[LOCATION]", "[PARAMETER]").toString())
.setRequestId("requestId693933066")
.build();
ApiFuture<Empty> future =
parameterManagerClient.deleteParameterCallable().futureCall(request);
// Do something.
future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<DeleteParameterRequest,Empty> |
|
deleteParameterVersion(@Nullable ParameterVersionName name)
public final void deleteParameterVersion(@Nullable ParameterVersionName name)Deletes a single ParameterVersion.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
ParameterVersionName name =
ParameterVersionName.of("[PROJECT]", "[LOCATION]", "[PARAMETER]", "[PARAMETER_VERSION]");
parameterManagerClient.deleteParameterVersion(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
@org.jspecify.annotations.Nullable com.google.cloud.parametermanager.v1.ParameterVersionNameRequired. Name of the resource in the format
|
deleteParameterVersion(DeleteParameterVersionRequest request)
public final void deleteParameterVersion(DeleteParameterVersionRequest request)Deletes a single ParameterVersion.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
DeleteParameterVersionRequest request =
DeleteParameterVersionRequest.newBuilder()
.setName(
ParameterVersionName.of(
"[PROJECT]", "[LOCATION]", "[PARAMETER]", "[PARAMETER_VERSION]")
.toString())
.setRequestId("requestId693933066")
.build();
parameterManagerClient.deleteParameterVersion(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
DeleteParameterVersionRequestThe request object containing all of the parameters for the API call. |
deleteParameterVersion(String name)
public final void deleteParameterVersion(String name)Deletes a single ParameterVersion.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
String name =
ParameterVersionName.of("[PROJECT]", "[LOCATION]", "[PARAMETER]", "[PARAMETER_VERSION]")
.toString();
parameterManagerClient.deleteParameterVersion(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. Name of the resource in the format
|
deleteParameterVersionCallable()
public final UnaryCallable<DeleteParameterVersionRequest,Empty> deleteParameterVersionCallable()Deletes a single ParameterVersion.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
DeleteParameterVersionRequest request =
DeleteParameterVersionRequest.newBuilder()
.setName(
ParameterVersionName.of(
"[PROJECT]", "[LOCATION]", "[PARAMETER]", "[PARAMETER_VERSION]")
.toString())
.setRequestId("requestId693933066")
.build();
ApiFuture<Empty> future =
parameterManagerClient.deleteParameterVersionCallable().futureCall(request);
// Do something.
future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<DeleteParameterVersionRequest,Empty> |
|
deleteTemplate(@Nullable TemplateName name)
public final void deleteTemplate(@Nullable TemplateName name)Deletes a single Template.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
TemplateName name = TemplateName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]");
parameterManagerClient.deleteTemplate(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
@org.jspecify.annotations.Nullable com.google.cloud.parametermanager.v1.TemplateNameRequired. Name of the resource in the format
|
deleteTemplate(DeleteTemplateRequest request)
public final void deleteTemplate(DeleteTemplateRequest request)Deletes a single Template.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
DeleteTemplateRequest request =
DeleteTemplateRequest.newBuilder()
.setName(TemplateName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]").toString())
.setRequestId("requestId693933066")
.build();
parameterManagerClient.deleteTemplate(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
DeleteTemplateRequestThe request object containing all of the parameters for the API call. |
deleteTemplate(String name)
public final void deleteTemplate(String name)Deletes a single Template.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
String name = TemplateName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]").toString();
parameterManagerClient.deleteTemplate(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. Name of the resource in the format
|
deleteTemplateCallable()
public final UnaryCallable<DeleteTemplateRequest,Empty> deleteTemplateCallable()Deletes a single Template.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
DeleteTemplateRequest request =
DeleteTemplateRequest.newBuilder()
.setName(TemplateName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]").toString())
.setRequestId("requestId693933066")
.build();
ApiFuture<Empty> future = parameterManagerClient.deleteTemplateCallable().futureCall(request);
// Do something.
future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<DeleteTemplateRequest,Empty> |
|
deleteTemplateVersion(@Nullable TemplateVersionName name)
public final void deleteTemplateVersion(@Nullable TemplateVersionName name)Deletes a single TemplateVersion.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
TemplateVersionName name =
TemplateVersionName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]", "[TEMPLATE_VERSION]");
parameterManagerClient.deleteTemplateVersion(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
@org.jspecify.annotations.Nullable com.google.cloud.parametermanager.v1.TemplateVersionNameRequired. Name of the resource in the format
|
deleteTemplateVersion(DeleteTemplateVersionRequest request)
public final void deleteTemplateVersion(DeleteTemplateVersionRequest request)Deletes a single TemplateVersion.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
DeleteTemplateVersionRequest request =
DeleteTemplateVersionRequest.newBuilder()
.setName(
TemplateVersionName.of(
"[PROJECT]", "[LOCATION]", "[TEMPLATE]", "[TEMPLATE_VERSION]")
.toString())
.setRequestId("requestId693933066")
.build();
parameterManagerClient.deleteTemplateVersion(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
DeleteTemplateVersionRequestThe request object containing all of the parameters for the API call. |
deleteTemplateVersion(String name)
public final void deleteTemplateVersion(String name)Deletes a single TemplateVersion.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
String name =
TemplateVersionName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]", "[TEMPLATE_VERSION]")
.toString();
parameterManagerClient.deleteTemplateVersion(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. Name of the resource in the format
|
deleteTemplateVersionCallable()
public final UnaryCallable<DeleteTemplateVersionRequest,Empty> deleteTemplateVersionCallable()Deletes a single TemplateVersion.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
DeleteTemplateVersionRequest request =
DeleteTemplateVersionRequest.newBuilder()
.setName(
TemplateVersionName.of(
"[PROJECT]", "[LOCATION]", "[TEMPLATE]", "[TEMPLATE_VERSION]")
.toString())
.setRequestId("requestId693933066")
.build();
ApiFuture<Empty> future =
parameterManagerClient.deleteTemplateVersionCallable().futureCall(request);
// Do something.
future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<DeleteTemplateVersionRequest,Empty> |
|
getLocation(GetLocationRequest request)
public final Location getLocation(GetLocationRequest request)Gets information about a location.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
Location response = parameterManagerClient.getLocation(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
com.google.cloud.location.GetLocationRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
com.google.cloud.location.Location |
|
getLocationCallable()
public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()Gets information about a location.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
ApiFuture<Location> future = parameterManagerClient.getLocationCallable().futureCall(request);
// Do something.
Location response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
|
getParameter(@Nullable ParameterName name)
public final Parameter getParameter(@Nullable ParameterName name)Gets details of a single Parameter.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
ParameterName name = ParameterName.of("[PROJECT]", "[LOCATION]", "[PARAMETER]");
Parameter response = parameterManagerClient.getParameter(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
@org.jspecify.annotations.Nullable com.google.cloud.parametermanager.v1.ParameterNameRequired. Name of the resource in the format
|
| Returns | |
|---|---|
| Type | Description |
Parameter |
|
getParameter(GetParameterRequest request)
public final Parameter getParameter(GetParameterRequest request)Gets details of a single Parameter.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
GetParameterRequest request =
GetParameterRequest.newBuilder()
.setName(ParameterName.of("[PROJECT]", "[LOCATION]", "[PARAMETER]").toString())
.build();
Parameter response = parameterManagerClient.getParameter(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
GetParameterRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
Parameter |
|
getParameter(String name)
public final Parameter getParameter(String name)Gets details of a single Parameter.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
String name = ParameterName.of("[PROJECT]", "[LOCATION]", "[PARAMETER]").toString();
Parameter response = parameterManagerClient.getParameter(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. Name of the resource in the format
|
| Returns | |
|---|---|
| Type | Description |
Parameter |
|
getParameterCallable()
public final UnaryCallable<GetParameterRequest,Parameter> getParameterCallable()Gets details of a single Parameter.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
GetParameterRequest request =
GetParameterRequest.newBuilder()
.setName(ParameterName.of("[PROJECT]", "[LOCATION]", "[PARAMETER]").toString())
.build();
ApiFuture<Parameter> future =
parameterManagerClient.getParameterCallable().futureCall(request);
// Do something.
Parameter response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<GetParameterRequest,Parameter> |
|
getParameterVersion(@Nullable ParameterVersionName name)
public final ParameterVersion getParameterVersion(@Nullable ParameterVersionName name)Gets details of a single ParameterVersion.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
ParameterVersionName name =
ParameterVersionName.of("[PROJECT]", "[LOCATION]", "[PARAMETER]", "[PARAMETER_VERSION]");
ParameterVersion response = parameterManagerClient.getParameterVersion(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
@org.jspecify.annotations.Nullable com.google.cloud.parametermanager.v1.ParameterVersionNameRequired. Name of the resource in the format
|
| Returns | |
|---|---|
| Type | Description |
ParameterVersion |
|
getParameterVersion(GetParameterVersionRequest request)
public final ParameterVersion getParameterVersion(GetParameterVersionRequest request)Gets details of a single ParameterVersion.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
GetParameterVersionRequest request =
GetParameterVersionRequest.newBuilder()
.setName(
ParameterVersionName.of(
"[PROJECT]", "[LOCATION]", "[PARAMETER]", "[PARAMETER_VERSION]")
.toString())
.setView(View.forNumber(0))
.build();
ParameterVersion response = parameterManagerClient.getParameterVersion(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
GetParameterVersionRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
ParameterVersion |
|
getParameterVersion(String name)
public final ParameterVersion getParameterVersion(String name)Gets details of a single ParameterVersion.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
String name =
ParameterVersionName.of("[PROJECT]", "[LOCATION]", "[PARAMETER]", "[PARAMETER_VERSION]")
.toString();
ParameterVersion response = parameterManagerClient.getParameterVersion(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. Name of the resource in the format
|
| Returns | |
|---|---|
| Type | Description |
ParameterVersion |
|
getParameterVersionCallable()
public final UnaryCallable<GetParameterVersionRequest,ParameterVersion> getParameterVersionCallable()Gets details of a single ParameterVersion.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
GetParameterVersionRequest request =
GetParameterVersionRequest.newBuilder()
.setName(
ParameterVersionName.of(
"[PROJECT]", "[LOCATION]", "[PARAMETER]", "[PARAMETER_VERSION]")
.toString())
.setView(View.forNumber(0))
.build();
ApiFuture<ParameterVersion> future =
parameterManagerClient.getParameterVersionCallable().futureCall(request);
// Do something.
ParameterVersion response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<GetParameterVersionRequest,ParameterVersion> |
|
getSettings()
public final @Nullable ParameterManagerSettings getSettings()| Returns | |
|---|---|
| Type | Description |
@org.jspecify.annotations.Nullable com.google.cloud.parametermanager.v1.ParameterManagerSettings |
|
getStub()
public ParameterManagerStub getStub()| Returns | |
|---|---|
| Type | Description |
ParameterManagerStub |
|
getTemplate(@Nullable TemplateName name)
public final Template getTemplate(@Nullable TemplateName name)Gets details of a single Template.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
TemplateName name = TemplateName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]");
Template response = parameterManagerClient.getTemplate(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
@org.jspecify.annotations.Nullable com.google.cloud.parametermanager.v1.TemplateNameRequired. Name of the resource in the format
|
| Returns | |
|---|---|
| Type | Description |
Template |
|
getTemplate(GetTemplateRequest request)
public final Template getTemplate(GetTemplateRequest request)Gets details of a single Template.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
GetTemplateRequest request =
GetTemplateRequest.newBuilder()
.setName(TemplateName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]").toString())
.build();
Template response = parameterManagerClient.getTemplate(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
GetTemplateRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
Template |
|
getTemplate(String name)
public final Template getTemplate(String name)Gets details of a single Template.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
String name = TemplateName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]").toString();
Template response = parameterManagerClient.getTemplate(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. Name of the resource in the format
|
| Returns | |
|---|---|
| Type | Description |
Template |
|
getTemplateCallable()
public final UnaryCallable<GetTemplateRequest,Template> getTemplateCallable()Gets details of a single Template.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
GetTemplateRequest request =
GetTemplateRequest.newBuilder()
.setName(TemplateName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]").toString())
.build();
ApiFuture<Template> future = parameterManagerClient.getTemplateCallable().futureCall(request);
// Do something.
Template response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<GetTemplateRequest,Template> |
|
getTemplateVersion(@Nullable TemplateVersionName name)
public final TemplateVersion getTemplateVersion(@Nullable TemplateVersionName name)Gets details of a single TemplateVersion.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
TemplateVersionName name =
TemplateVersionName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]", "[TEMPLATE_VERSION]");
TemplateVersion response = parameterManagerClient.getTemplateVersion(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
@org.jspecify.annotations.Nullable com.google.cloud.parametermanager.v1.TemplateVersionNameRequired. Name of the resource in the format
|
| Returns | |
|---|---|
| Type | Description |
TemplateVersion |
|
getTemplateVersion(GetTemplateVersionRequest request)
public final TemplateVersion getTemplateVersion(GetTemplateVersionRequest request)Gets details of a single TemplateVersion.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
GetTemplateVersionRequest request =
GetTemplateVersionRequest.newBuilder()
.setName(
TemplateVersionName.of(
"[PROJECT]", "[LOCATION]", "[TEMPLATE]", "[TEMPLATE_VERSION]")
.toString())
.setView(View.forNumber(0))
.build();
TemplateVersion response = parameterManagerClient.getTemplateVersion(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
GetTemplateVersionRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
TemplateVersion |
|
getTemplateVersion(String name)
public final TemplateVersion getTemplateVersion(String name)Gets details of a single TemplateVersion.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
String name =
TemplateVersionName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]", "[TEMPLATE_VERSION]")
.toString();
TemplateVersion response = parameterManagerClient.getTemplateVersion(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. Name of the resource in the format
|
| Returns | |
|---|---|
| Type | Description |
TemplateVersion |
|
getTemplateVersionCallable()
public final UnaryCallable<GetTemplateVersionRequest,TemplateVersion> getTemplateVersionCallable()Gets details of a single TemplateVersion.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
GetTemplateVersionRequest request =
GetTemplateVersionRequest.newBuilder()
.setName(
TemplateVersionName.of(
"[PROJECT]", "[LOCATION]", "[TEMPLATE]", "[TEMPLATE_VERSION]")
.toString())
.setView(View.forNumber(0))
.build();
ApiFuture<TemplateVersion> future =
parameterManagerClient.getTemplateVersionCallable().futureCall(request);
// Do something.
TemplateVersion response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<GetTemplateVersionRequest,TemplateVersion> |
|
isShutdown()
public boolean isShutdown()| Returns | |
|---|---|
| Type | Description |
boolean |
|
isTerminated()
public boolean isTerminated()| Returns | |
|---|---|
| Type | Description |
boolean |
|
listLocations(ListLocationsRequest request)
public final ParameterManagerClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)Lists information about the supported locations for this service.
This method lists locations based on the resource scope provided inthe
ListLocationsRequest.name field:
***Global locations**: If name is empty, the method lists thepublic
locations available to all projects. * **Project-specificlocations**: If
name follows the formatprojects/{project}, the method lists locations visible to
thatspecific project. This includes public, private, or otherproject-specific locations enabled
for the project.
For gRPC and client library implementations, the resource name ispassed as the name field.
For direct service calls, the resourcename isincorporated into the request path based on the
specific serviceimplementation and version.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (Location element : parameterManagerClient.listLocations(request).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
com.google.cloud.location.ListLocationsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
ParameterManagerClient.ListLocationsPagedResponse |
|
listLocationsCallable()
public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()Lists information about the supported locations for this service.
This method lists locations based on the resource scope provided inthe
ListLocationsRequest.name field:
***Global locations**: If name is empty, the method lists thepublic
locations available to all projects. * **Project-specificlocations**: If
name follows the formatprojects/{project}, the method lists locations visible to
thatspecific project. This includes public, private, or otherproject-specific locations enabled
for the project.
For gRPC and client library implementations, the resource name ispassed as the name field.
For direct service calls, the resourcename isincorporated into the request path based on the
specific serviceimplementation and version.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListLocationsResponse response =
parameterManagerClient.listLocationsCallable().call(request);
for (Location element : response.getLocationsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse> |
|
listLocationsPagedCallable()
public final UnaryCallable<ListLocationsRequest,ParameterManagerClient.ListLocationsPagedResponse> listLocationsPagedCallable()Lists information about the supported locations for this service.
This method lists locations based on the resource scope provided inthe
ListLocationsRequest.name field:
***Global locations**: If name is empty, the method lists thepublic
locations available to all projects. * **Project-specificlocations**: If
name follows the formatprojects/{project}, the method lists locations visible to
thatspecific project. This includes public, private, or otherproject-specific locations enabled
for the project.
For gRPC and client library implementations, the resource name ispassed as the name field.
For direct service calls, the resourcename isincorporated into the request path based on the
specific serviceimplementation and version.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
ListLocationsRequest request =
ListLocationsRequest.newBuilder()
.setName("name3373707")
.setFilter("filter-1274492040")
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<Location> future =
parameterManagerClient.listLocationsPagedCallable().futureCall(request);
// Do something.
for (Location element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse> |
|
listParameterVersions(@Nullable ParameterName parent)
public final ParameterManagerClient.ListParameterVersionsPagedResponse listParameterVersions(@Nullable ParameterName parent)Lists ParameterVersions in a given project, location, and parameter.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
ParameterName parent = ParameterName.of("[PROJECT]", "[LOCATION]", "[PARAMETER]");
for (ParameterVersion element :
parameterManagerClient.listParameterVersions(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
@org.jspecify.annotations.Nullable com.google.cloud.parametermanager.v1.ParameterNameRequired. Parent value for ListParameterVersionsRequest in the format
|
| Returns | |
|---|---|
| Type | Description |
ParameterManagerClient.ListParameterVersionsPagedResponse |
|
listParameterVersions(ListParameterVersionsRequest request)
public final ParameterManagerClient.ListParameterVersionsPagedResponse listParameterVersions(ListParameterVersionsRequest request)Lists ParameterVersions in a given project, location, and parameter.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
ListParameterVersionsRequest request =
ListParameterVersionsRequest.newBuilder()
.setParent(ParameterName.of("[PROJECT]", "[LOCATION]", "[PARAMETER]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
for (ParameterVersion element :
parameterManagerClient.listParameterVersions(request).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
ListParameterVersionsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
ParameterManagerClient.ListParameterVersionsPagedResponse |
|
listParameterVersions(String parent)
public final ParameterManagerClient.ListParameterVersionsPagedResponse listParameterVersions(String parent)Lists ParameterVersions in a given project, location, and parameter.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
String parent = ParameterName.of("[PROJECT]", "[LOCATION]", "[PARAMETER]").toString();
for (ParameterVersion element :
parameterManagerClient.listParameterVersions(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
StringRequired. Parent value for ListParameterVersionsRequest in the format
|
| Returns | |
|---|---|
| Type | Description |
ParameterManagerClient.ListParameterVersionsPagedResponse |
|
listParameterVersionsCallable()
public final UnaryCallable<ListParameterVersionsRequest,ListParameterVersionsResponse> listParameterVersionsCallable()Lists ParameterVersions in a given project, location, and parameter.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
ListParameterVersionsRequest request =
ListParameterVersionsRequest.newBuilder()
.setParent(ParameterName.of("[PROJECT]", "[LOCATION]", "[PARAMETER]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListParameterVersionsResponse response =
parameterManagerClient.listParameterVersionsCallable().call(request);
for (ParameterVersion element : response.getParameterVersionsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListParameterVersionsRequest,ListParameterVersionsResponse> |
|
listParameterVersionsPagedCallable()
public final UnaryCallable<ListParameterVersionsRequest,ParameterManagerClient.ListParameterVersionsPagedResponse> listParameterVersionsPagedCallable()Lists ParameterVersions in a given project, location, and parameter.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
ListParameterVersionsRequest request =
ListParameterVersionsRequest.newBuilder()
.setParent(ParameterName.of("[PROJECT]", "[LOCATION]", "[PARAMETER]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<ParameterVersion> future =
parameterManagerClient.listParameterVersionsPagedCallable().futureCall(request);
// Do something.
for (ParameterVersion element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListParameterVersionsRequest,ListParameterVersionsPagedResponse> |
|
listParameters(@Nullable LocationName parent)
public final ParameterManagerClient.ListParametersPagedResponse listParameters(@Nullable LocationName parent)Lists Parameters in a given project and location.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (Parameter element : parameterManagerClient.listParameters(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
@org.jspecify.annotations.Nullable com.google.cloud.parametermanager.v1.LocationNameRequired. Parent value for ListParametersRequest in the format
|
| Returns | |
|---|---|
| Type | Description |
ParameterManagerClient.ListParametersPagedResponse |
|
listParameters(ListParametersRequest request)
public final ParameterManagerClient.ListParametersPagedResponse listParameters(ListParametersRequest request)Lists Parameters in a given project and location.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
ListParametersRequest request =
ListParametersRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
for (Parameter element : parameterManagerClient.listParameters(request).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
ListParametersRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
ParameterManagerClient.ListParametersPagedResponse |
|
listParameters(String parent)
public final ParameterManagerClient.ListParametersPagedResponse listParameters(String parent)Lists Parameters in a given project and location.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (Parameter element : parameterManagerClient.listParameters(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
StringRequired. Parent value for ListParametersRequest in the format
|
| Returns | |
|---|---|
| Type | Description |
ParameterManagerClient.ListParametersPagedResponse |
|
listParametersCallable()
public final UnaryCallable<ListParametersRequest,ListParametersResponse> listParametersCallable()Lists Parameters in a given project and location.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
ListParametersRequest request =
ListParametersRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListParametersResponse response =
parameterManagerClient.listParametersCallable().call(request);
for (Parameter element : response.getParametersList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListParametersRequest,ListParametersResponse> |
|
listParametersPagedCallable()
public final UnaryCallable<ListParametersRequest,ParameterManagerClient.ListParametersPagedResponse> listParametersPagedCallable()Lists Parameters in a given project and location.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
ListParametersRequest request =
ListParametersRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<Parameter> future =
parameterManagerClient.listParametersPagedCallable().futureCall(request);
// Do something.
for (Parameter element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListParametersRequest,ListParametersPagedResponse> |
|
listTemplateVersions(@Nullable TemplateName parent)
public final ParameterManagerClient.ListTemplateVersionsPagedResponse listTemplateVersions(@Nullable TemplateName parent)Lists TemplateVersions in a given project, location, and template.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
TemplateName parent = TemplateName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]");
for (TemplateVersion element :
parameterManagerClient.listTemplateVersions(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
@org.jspecify.annotations.Nullable com.google.cloud.parametermanager.v1.TemplateNameRequired. Parent value for ListTemplateVersionsRequest in the format
|
| Returns | |
|---|---|
| Type | Description |
ParameterManagerClient.ListTemplateVersionsPagedResponse |
|
listTemplateVersions(ListTemplateVersionsRequest request)
public final ParameterManagerClient.ListTemplateVersionsPagedResponse listTemplateVersions(ListTemplateVersionsRequest request)Lists TemplateVersions in a given project, location, and template.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
ListTemplateVersionsRequest request =
ListTemplateVersionsRequest.newBuilder()
.setParent(TemplateName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
for (TemplateVersion element :
parameterManagerClient.listTemplateVersions(request).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
ListTemplateVersionsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
ParameterManagerClient.ListTemplateVersionsPagedResponse |
|
listTemplateVersions(String parent)
public final ParameterManagerClient.ListTemplateVersionsPagedResponse listTemplateVersions(String parent)Lists TemplateVersions in a given project, location, and template.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
String parent = TemplateName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]").toString();
for (TemplateVersion element :
parameterManagerClient.listTemplateVersions(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
StringRequired. Parent value for ListTemplateVersionsRequest in the format
|
| Returns | |
|---|---|
| Type | Description |
ParameterManagerClient.ListTemplateVersionsPagedResponse |
|
listTemplateVersionsCallable()
public final UnaryCallable<ListTemplateVersionsRequest,ListTemplateVersionsResponse> listTemplateVersionsCallable()Lists TemplateVersions in a given project, location, and template.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
ListTemplateVersionsRequest request =
ListTemplateVersionsRequest.newBuilder()
.setParent(TemplateName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListTemplateVersionsResponse response =
parameterManagerClient.listTemplateVersionsCallable().call(request);
for (TemplateVersion element : response.getTemplateVersionsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListTemplateVersionsRequest,ListTemplateVersionsResponse> |
|
listTemplateVersionsPagedCallable()
public final UnaryCallable<ListTemplateVersionsRequest,ParameterManagerClient.ListTemplateVersionsPagedResponse> listTemplateVersionsPagedCallable()Lists TemplateVersions in a given project, location, and template.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
ListTemplateVersionsRequest request =
ListTemplateVersionsRequest.newBuilder()
.setParent(TemplateName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<TemplateVersion> future =
parameterManagerClient.listTemplateVersionsPagedCallable().futureCall(request);
// Do something.
for (TemplateVersion element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListTemplateVersionsRequest,ListTemplateVersionsPagedResponse> |
|
listTemplates(@Nullable LocationName parent)
public final ParameterManagerClient.ListTemplatesPagedResponse listTemplates(@Nullable LocationName parent)Lists Templates in a given project and location.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (Template element : parameterManagerClient.listTemplates(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
@org.jspecify.annotations.Nullable com.google.cloud.parametermanager.v1.LocationNameRequired. Parent value for ListTemplatesRequest in the format
|
| Returns | |
|---|---|
| Type | Description |
ParameterManagerClient.ListTemplatesPagedResponse |
|
listTemplates(ListTemplatesRequest request)
public final ParameterManagerClient.ListTemplatesPagedResponse listTemplates(ListTemplatesRequest request)Lists Templates in a given project and location.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
ListTemplatesRequest request =
ListTemplatesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
for (Template element : parameterManagerClient.listTemplates(request).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
ListTemplatesRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
ParameterManagerClient.ListTemplatesPagedResponse |
|
listTemplates(String parent)
public final ParameterManagerClient.ListTemplatesPagedResponse listTemplates(String parent)Lists Templates in a given project and location.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (Template element : parameterManagerClient.listTemplates(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
StringRequired. Parent value for ListTemplatesRequest in the format
|
| Returns | |
|---|---|
| Type | Description |
ParameterManagerClient.ListTemplatesPagedResponse |
|
listTemplatesCallable()
public final UnaryCallable<ListTemplatesRequest,ListTemplatesResponse> listTemplatesCallable()Lists Templates in a given project and location.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
ListTemplatesRequest request =
ListTemplatesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListTemplatesResponse response =
parameterManagerClient.listTemplatesCallable().call(request);
for (Template element : response.getTemplatesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListTemplatesRequest,ListTemplatesResponse> |
|
listTemplatesPagedCallable()
public final UnaryCallable<ListTemplatesRequest,ParameterManagerClient.ListTemplatesPagedResponse> listTemplatesPagedCallable()Lists Templates in a given project and location.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
ListTemplatesRequest request =
ListTemplatesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<Template> future =
parameterManagerClient.listTemplatesPagedCallable().futureCall(request);
// Do something.
for (Template element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListTemplatesRequest,ListTemplatesPagedResponse> |
|
renderParameterVersion(@Nullable ParameterVersionName name)
public final RenderParameterVersionResponse renderParameterVersion(@Nullable ParameterVersionName name)Gets rendered version of a ParameterVersion.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
ParameterVersionName name =
ParameterVersionName.of("[PROJECT]", "[LOCATION]", "[PARAMETER]", "[PARAMETER_VERSION]");
RenderParameterVersionResponse response = parameterManagerClient.renderParameterVersion(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
@org.jspecify.annotations.Nullable com.google.cloud.parametermanager.v1.ParameterVersionNameRequired. Name of the resource |
| Returns | |
|---|---|
| Type | Description |
RenderParameterVersionResponse |
|
renderParameterVersion(RenderParameterVersionRequest request)
public final RenderParameterVersionResponse renderParameterVersion(RenderParameterVersionRequest request)Gets rendered version of a ParameterVersion.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
RenderParameterVersionRequest request =
RenderParameterVersionRequest.newBuilder()
.setName(
ParameterVersionName.of(
"[PROJECT]", "[LOCATION]", "[PARAMETER]", "[PARAMETER_VERSION]")
.toString())
.build();
RenderParameterVersionResponse response =
parameterManagerClient.renderParameterVersion(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
RenderParameterVersionRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
RenderParameterVersionResponse |
|
renderParameterVersion(String name)
public final RenderParameterVersionResponse renderParameterVersion(String name)Gets rendered version of a ParameterVersion.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
String name =
ParameterVersionName.of("[PROJECT]", "[LOCATION]", "[PARAMETER]", "[PARAMETER_VERSION]")
.toString();
RenderParameterVersionResponse response = parameterManagerClient.renderParameterVersion(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. Name of the resource |
| Returns | |
|---|---|
| Type | Description |
RenderParameterVersionResponse |
|
renderParameterVersionCallable()
public final UnaryCallable<RenderParameterVersionRequest,RenderParameterVersionResponse> renderParameterVersionCallable()Gets rendered version of a ParameterVersion.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
RenderParameterVersionRequest request =
RenderParameterVersionRequest.newBuilder()
.setName(
ParameterVersionName.of(
"[PROJECT]", "[LOCATION]", "[PARAMETER]", "[PARAMETER_VERSION]")
.toString())
.build();
ApiFuture<RenderParameterVersionResponse> future =
parameterManagerClient.renderParameterVersionCallable().futureCall(request);
// Do something.
RenderParameterVersionResponse response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<RenderParameterVersionRequest,RenderParameterVersionResponse> |
|
renderTemplateVersion(@Nullable TemplateVersionName name)
public final RenderTemplateVersionResponse renderTemplateVersion(@Nullable TemplateVersionName name)Gets rendered version of a TemplateVersion.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
TemplateVersionName name =
TemplateVersionName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]", "[TEMPLATE_VERSION]");
RenderTemplateVersionResponse response = parameterManagerClient.renderTemplateVersion(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
@org.jspecify.annotations.Nullable com.google.cloud.parametermanager.v1.TemplateVersionNameRequired. Name of the resource |
| Returns | |
|---|---|
| Type | Description |
RenderTemplateVersionResponse |
|
renderTemplateVersion(RenderTemplateVersionRequest request)
public final RenderTemplateVersionResponse renderTemplateVersion(RenderTemplateVersionRequest request)Gets rendered version of a TemplateVersion.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
RenderTemplateVersionRequest request =
RenderTemplateVersionRequest.newBuilder()
.setName(
TemplateVersionName.of(
"[PROJECT]", "[LOCATION]", "[TEMPLATE]", "[TEMPLATE_VERSION]")
.toString())
.setParameterVersion(
ParameterVersionName.of(
"[PROJECT]", "[LOCATION]", "[PARAMETER]", "[PARAMETER_VERSION]")
.toString())
.build();
RenderTemplateVersionResponse response =
parameterManagerClient.renderTemplateVersion(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
RenderTemplateVersionRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
RenderTemplateVersionResponse |
|
renderTemplateVersion(String name)
public final RenderTemplateVersionResponse renderTemplateVersion(String name)Gets rendered version of a TemplateVersion.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
String name =
TemplateVersionName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]", "[TEMPLATE_VERSION]")
.toString();
RenderTemplateVersionResponse response = parameterManagerClient.renderTemplateVersion(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. Name of the resource |
| Returns | |
|---|---|
| Type | Description |
RenderTemplateVersionResponse |
|
renderTemplateVersionCallable()
public final UnaryCallable<RenderTemplateVersionRequest,RenderTemplateVersionResponse> renderTemplateVersionCallable()Gets rendered version of a TemplateVersion.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
RenderTemplateVersionRequest request =
RenderTemplateVersionRequest.newBuilder()
.setName(
TemplateVersionName.of(
"[PROJECT]", "[LOCATION]", "[TEMPLATE]", "[TEMPLATE_VERSION]")
.toString())
.setParameterVersion(
ParameterVersionName.of(
"[PROJECT]", "[LOCATION]", "[PARAMETER]", "[PARAMETER_VERSION]")
.toString())
.build();
ApiFuture<RenderTemplateVersionResponse> future =
parameterManagerClient.renderTemplateVersionCallable().futureCall(request);
// Do something.
RenderTemplateVersionResponse response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<RenderTemplateVersionRequest,RenderTemplateVersionResponse> |
|
shutdown()
public void shutdown()shutdownNow()
public void shutdownNow()updateParameter(Parameter parameter, FieldMask updateMask)
public final Parameter updateParameter(Parameter parameter, FieldMask updateMask)Updates a single Parameter.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
Parameter parameter = Parameter.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Parameter response = parameterManagerClient.updateParameter(parameter, updateMask);
}
| Parameters | |
|---|---|
| Name | Description |
parameter |
ParameterRequired. The Parameter resource being updated |
updateMask |
FieldMaskOptional. 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. |
| Returns | |
|---|---|
| Type | Description |
Parameter |
|
updateParameter(UpdateParameterRequest request)
public final Parameter updateParameter(UpdateParameterRequest request)Updates a single Parameter.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
UpdateParameterRequest request =
UpdateParameterRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setParameter(Parameter.newBuilder().build())
.setRequestId("requestId693933066")
.build();
Parameter response = parameterManagerClient.updateParameter(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
UpdateParameterRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
Parameter |
|
updateParameterCallable()
public final UnaryCallable<UpdateParameterRequest,Parameter> updateParameterCallable()Updates a single Parameter.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
UpdateParameterRequest request =
UpdateParameterRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setParameter(Parameter.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<Parameter> future =
parameterManagerClient.updateParameterCallable().futureCall(request);
// Do something.
Parameter response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<UpdateParameterRequest,Parameter> |
|
updateParameterVersion(ParameterVersion parameterVersion, FieldMask updateMask)
public final ParameterVersion updateParameterVersion(ParameterVersion parameterVersion, FieldMask updateMask)Updates a single ParameterVersion.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
ParameterVersion parameterVersion = ParameterVersion.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
ParameterVersion response =
parameterManagerClient.updateParameterVersion(parameterVersion, updateMask);
}
| Parameters | |
|---|---|
| Name | Description |
parameterVersion |
ParameterVersionRequired. The ParameterVersion resource being updated |
updateMask |
FieldMaskOptional. 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. |
| Returns | |
|---|---|
| Type | Description |
ParameterVersion |
|
updateParameterVersion(UpdateParameterVersionRequest request)
public final ParameterVersion updateParameterVersion(UpdateParameterVersionRequest request)Updates a single ParameterVersion.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
UpdateParameterVersionRequest request =
UpdateParameterVersionRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setParameterVersion(ParameterVersion.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ParameterVersion response = parameterManagerClient.updateParameterVersion(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
UpdateParameterVersionRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
ParameterVersion |
|
updateParameterVersionCallable()
public final UnaryCallable<UpdateParameterVersionRequest,ParameterVersion> updateParameterVersionCallable()Updates a single ParameterVersion.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
UpdateParameterVersionRequest request =
UpdateParameterVersionRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setParameterVersion(ParameterVersion.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<ParameterVersion> future =
parameterManagerClient.updateParameterVersionCallable().futureCall(request);
// Do something.
ParameterVersion response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<UpdateParameterVersionRequest,ParameterVersion> |
|
updateTemplate(Template template, FieldMask updateMask)
public final Template updateTemplate(Template template, FieldMask updateMask)Updates a single Template.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
Template template = Template.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Template response = parameterManagerClient.updateTemplate(template, updateMask);
}
| Parameters | |
|---|---|
| Name | Description |
template |
TemplateRequired. The Template resource being updated |
updateMask |
FieldMaskOptional. Field mask is used to specify the fields to be overwritten in the Template 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. |
| Returns | |
|---|---|
| Type | Description |
Template |
|
updateTemplate(UpdateTemplateRequest request)
public final Template updateTemplate(UpdateTemplateRequest request)Updates a single Template.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
UpdateTemplateRequest request =
UpdateTemplateRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setTemplate(Template.newBuilder().build())
.setRequestId("requestId693933066")
.build();
Template response = parameterManagerClient.updateTemplate(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
UpdateTemplateRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
Template |
|
updateTemplateCallable()
public final UnaryCallable<UpdateTemplateRequest,Template> updateTemplateCallable()Updates a single Template.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
UpdateTemplateRequest request =
UpdateTemplateRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setTemplate(Template.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<Template> future =
parameterManagerClient.updateTemplateCallable().futureCall(request);
// Do something.
Template response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<UpdateTemplateRequest,Template> |
|
updateTemplateVersion(TemplateVersion templateVersion, FieldMask updateMask)
public final TemplateVersion updateTemplateVersion(TemplateVersion templateVersion, FieldMask updateMask)Updates a single TemplateVersion.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
TemplateVersion templateVersion = TemplateVersion.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
TemplateVersion response =
parameterManagerClient.updateTemplateVersion(templateVersion, updateMask);
}
| Parameters | |
|---|---|
| Name | Description |
templateVersion |
TemplateVersionRequired. The TemplateVersion resource being updated |
updateMask |
FieldMaskOptional. Field mask is used to specify the fields to be overwritten in the TemplateVersion 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. |
| Returns | |
|---|---|
| Type | Description |
TemplateVersion |
|
updateTemplateVersion(UpdateTemplateVersionRequest request)
public final TemplateVersion updateTemplateVersion(UpdateTemplateVersionRequest request)Updates a single TemplateVersion.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
UpdateTemplateVersionRequest request =
UpdateTemplateVersionRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setTemplateVersion(TemplateVersion.newBuilder().build())
.setRequestId("requestId693933066")
.build();
TemplateVersion response = parameterManagerClient.updateTemplateVersion(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
UpdateTemplateVersionRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
TemplateVersion |
|
updateTemplateVersionCallable()
public final UnaryCallable<UpdateTemplateVersionRequest,TemplateVersion> updateTemplateVersionCallable()Updates a single TemplateVersion.
Sample code:
// 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (ParameterManagerClient parameterManagerClient = ParameterManagerClient.create()) {
UpdateTemplateVersionRequest request =
UpdateTemplateVersionRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setTemplateVersion(TemplateVersion.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<TemplateVersion> future =
parameterManagerClient.updateTemplateVersionCallable().futureCall(request);
// Do something.
TemplateVersion response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<UpdateTemplateVersionRequest,TemplateVersion> |
|