Class ParameterManagerClient (0.1.0)

GitHub RepositoryProduct 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().

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

  • listParameters(ListParametersRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listParameters(LocationName parent)

  • listParameters(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listParametersPagedCallable()

  • listParametersCallable()

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.

  • getParameter(GetParameterRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getParameter(ParameterName name)

  • getParameter(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getParameterCallable()

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.

  • createParameter(CreateParameterRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createParameter(LocationName parent, Parameter parameter, String parameterId)

  • createParameter(String parent, Parameter parameter, String parameterId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createParameterCallable()

UpdateParameter

Updates a single Parameter.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateParameter(UpdateParameterRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateParameter(Parameter parameter, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateParameterCallable()

DeleteParameter

Deletes a single Parameter.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteParameter(DeleteParameterRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteParameter(ParameterName name)

  • deleteParameter(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteParameterCallable()

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.

  • listParameterVersions(ListParameterVersionsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listParameterVersions(ParameterName parent)

  • listParameterVersions(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listParameterVersionsPagedCallable()

  • listParameterVersionsCallable()

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.

  • getParameterVersion(GetParameterVersionRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getParameterVersion(ParameterVersionName name)

  • getParameterVersion(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getParameterVersionCallable()

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.

  • renderParameterVersion(RenderParameterVersionRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • renderParameterVersion(ParameterVersionName name)

  • renderParameterVersion(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • renderParameterVersionCallable()

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.

  • createParameterVersion(CreateParameterVersionRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createParameterVersion(ParameterName parent, ParameterVersion parameterVersion, String parameterVersionId)

  • createParameterVersion(String parent, ParameterVersion parameterVersion, String parameterVersionId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createParameterVersionCallable()

UpdateParameterVersion

Updates a single ParameterVersion.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateParameterVersion(UpdateParameterVersionRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateParameterVersion(ParameterVersion parameterVersion, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateParameterVersionCallable()

DeleteParameterVersion

Deletes a single ParameterVersion.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteParameterVersion(DeleteParameterVersionRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteParameterVersion(ParameterVersionName name)

  • deleteParameterVersion(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteParameterVersionCallable()

ListLocations

Lists information about the supported locations for this service.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listLocations(ListLocationsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listLocationsPagedCallable()

  • listLocationsCallable()

GetLocation

Gets information about a location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getLocation(GetLocationRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getLocationCallable()

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.

Inheritance

java.lang.Object > ParameterManagerClient

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(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 CreateParameterRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Parameter

createParameter(LocationName parent, Parameter parameter, String parameterId)

public final Parameter createParameter(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 LocationName

Required. Value for parent in the format projects/*/locations/*.

parameter Parameter

Required. The Parameter resource being created

parameterId String

Required. Id of the Parameter resource

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 String

Required. Value for parent in the format projects/*/locations/*.

parameter Parameter

Required. The Parameter resource being created

parameterId String

Required. 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(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 CreateParameterVersionRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
ParameterVersion

createParameterVersion(ParameterName parent, ParameterVersion parameterVersion, String parameterVersionId)

public final ParameterVersion createParameterVersion(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 ParameterName

Required. Value for parent in the format projects/*/locations/*/parameters/*.

parameterVersion ParameterVersion

Required. The ParameterVersion resource being created

parameterVersionId String

Required. Id of the ParameterVersion resource

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 String

Required. Value for parent in the format projects/*/locations/*/parameters/*.

parameterVersion ParameterVersion

Required. The ParameterVersion resource being created

parameterVersionId String

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

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 DeleteParameterRequest

The request object containing all of the parameters for the API call.

deleteParameter(ParameterName name)

public final void deleteParameter(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 ParameterName

Required. Name of the resource in the format projects/*/locations/*/parameters/*.

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 String

Required. Name of the resource in the format projects/*/locations/*/parameters/*.

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(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 DeleteParameterVersionRequest

The request object containing all of the parameters for the API call.

deleteParameterVersion(ParameterVersionName name)

public final void deleteParameterVersion(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 ParameterVersionName

Required. Name of the resource in the format projects/*/locations/*/parameters/*/versions/*.

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 String

Required. Name of the resource in the format projects/*/locations/*/parameters/*/versions/*.

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>

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

The 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(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 GetParameterRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
Parameter

getParameter(ParameterName name)

public final Parameter getParameter(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 ParameterName

Required. Name of the resource in the format projects/*/locations/*/parameters/*.

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 String

Required. Name of the resource in the format projects/*/locations/*/parameters/*.

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(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 GetParameterVersionRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
ParameterVersion

getParameterVersion(ParameterVersionName name)

public final ParameterVersion getParameterVersion(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 ParameterVersionName

Required. Name of the resource in the format projects/*/locations/*/parameters/*/versions/*.

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 String

Required. Name of the resource in the format projects/*/locations/*/parameters/*/versions/*.

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 ParameterManagerSettings getSettings()
Returns
Type Description
ParameterManagerSettings

getStub()

public ParameterManagerStub getStub()
Returns
Type Description
ParameterManagerStub

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.

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

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

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.

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(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 ListParameterVersionsRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
ParameterManagerClient.ListParameterVersionsPagedResponse

listParameterVersions(ParameterName parent)

public final ParameterManagerClient.ListParameterVersionsPagedResponse listParameterVersions(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 ParameterName

Required. Parent value for ListParameterVersionsRequest in the format projects/*/locations/*/parameters/*.

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 String

Required. Parent value for ListParameterVersionsRequest in the format projects/*/locations/*/parameters/*.

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(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 ListParametersRequest

The request object containing all of the parameters for the API call.

Returns
Type Description
ParameterManagerClient.ListParametersPagedResponse

listParameters(LocationName parent)

public final ParameterManagerClient.ListParametersPagedResponse listParameters(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 LocationName

Required. Parent value for ListParametersRequest in the format projects/*/locations/*.

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 String

Required. Parent value for ListParametersRequest in the format projects/*/locations/*.

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>

renderParameterVersion(ParameterVersionName name)

public final RenderParameterVersionResponse renderParameterVersion(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 ParameterVersionName

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

The 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 String

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

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 Parameter

Required. The Parameter resource being updated

updateMask FieldMask

Optional. Field mask is used to specify the fields to be overwritten in the Parameter resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A mutable field will be overwritten if it is in the mask. If the user does not provide a mask then all mutable fields present in the request will be overwritten.

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 UpdateParameterRequest

The 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 ParameterVersion

Required. The ParameterVersion resource being updated

updateMask FieldMask

Optional. Field mask is used to specify the fields to be overwritten in the ParameterVersion resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A mutable field will be overwritten if it is in the mask. If the user does not provide a mask then all mutable fields present in the request will be overwritten.

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 UpdateParameterVersionRequest

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