ParameterManagerClient (Google Parameter Manager API 0.17.0 API)

java.lang.Object
- com.google.cloud.parametermanager.v1.ParameterManagerClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class ParameterManagerClient
extends Object
implements com.google.api.gax.core.BackgroundResource

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.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ParameterManagerClient.ListLocationsFixedSizeCollection`
`static class`	`ParameterManagerClient.ListLocationsPage`
`static class`	`ParameterManagerClient.ListLocationsPagedResponse`
`static class`	`ParameterManagerClient.ListParametersFixedSizeCollection`
`static class`	`ParameterManagerClient.ListParametersPage`
`static class`	`ParameterManagerClient.ListParametersPagedResponse`
`static class`	`ParameterManagerClient.ListParameterVersionsFixedSizeCollection`
`static class`	`ParameterManagerClient.ListParameterVersionsPage`
`static class`	`ParameterManagerClient.ListParameterVersionsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ParameterManagerClient(ParameterManagerSettings settings)` Constructs an instance of ParameterManagerClient, using the given settings.
`protected`	`ParameterManagerClient(ParameterManagerStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static ParameterManagerClient`	`create()` Constructs an instance of ParameterManagerClient with default settings.
`static ParameterManagerClient`	`create(ParameterManagerSettings settings)` Constructs an instance of ParameterManagerClient, using the given settings.
`static ParameterManagerClient`	`create(ParameterManagerStub stub)` Constructs an instance of ParameterManagerClient, using the given stub for making calls.
`Parameter`	`createParameter(CreateParameterRequest request)` Creates a new Parameter in a given project and location.
`Parameter`	`createParameter(LocationName parent, Parameter parameter, String parameterId)` Creates a new Parameter in a given project and location.
`Parameter`	`createParameter(String parent, Parameter parameter, String parameterId)` Creates a new Parameter in a given project and location.
`com.google.api.gax.rpc.UnaryCallable<CreateParameterRequest,Parameter>`	`createParameterCallable()` Creates a new Parameter in a given project and location.
`ParameterVersion`	`createParameterVersion(CreateParameterVersionRequest request)` Creates a new ParameterVersion in a given project, location, and parameter.
`ParameterVersion`	`createParameterVersion(ParameterName parent, ParameterVersion parameterVersion, String parameterVersionId)` Creates a new ParameterVersion in a given project, location, and parameter.
`ParameterVersion`	`createParameterVersion(String parent, ParameterVersion parameterVersion, String parameterVersionId)` Creates a new ParameterVersion in a given project, location, and parameter.
`com.google.api.gax.rpc.UnaryCallable<CreateParameterVersionRequest,ParameterVersion>`	`createParameterVersionCallable()` Creates a new ParameterVersion in a given project, location, and parameter.
`void`	`deleteParameter(DeleteParameterRequest request)` Deletes a single Parameter.
`void`	`deleteParameter(ParameterName name)` Deletes a single Parameter.
`void`	`deleteParameter(String name)` Deletes a single Parameter.
`com.google.api.gax.rpc.UnaryCallable<DeleteParameterRequest,com.google.protobuf.Empty>`	`deleteParameterCallable()` Deletes a single Parameter.
`void`	`deleteParameterVersion(DeleteParameterVersionRequest request)` Deletes a single ParameterVersion.
`void`	`deleteParameterVersion(ParameterVersionName name)` Deletes a single ParameterVersion.
`void`	`deleteParameterVersion(String name)` Deletes a single ParameterVersion.
`com.google.api.gax.rpc.UnaryCallable<DeleteParameterVersionRequest,com.google.protobuf.Empty>`	`deleteParameterVersionCallable()` Deletes a single ParameterVersion.
`com.google.cloud.location.Location`	`getLocation(com.google.cloud.location.GetLocationRequest request)` Gets information about a location.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`	`getLocationCallable()` Gets information about a location.
`Parameter`	`getParameter(GetParameterRequest request)` Gets details of a single Parameter.
`Parameter`	`getParameter(ParameterName name)` Gets details of a single Parameter.
`Parameter`	`getParameter(String name)` Gets details of a single Parameter.
`com.google.api.gax.rpc.UnaryCallable<GetParameterRequest,Parameter>`	`getParameterCallable()` Gets details of a single Parameter.
`ParameterVersion`	`getParameterVersion(GetParameterVersionRequest request)` Gets details of a single ParameterVersion.
`ParameterVersion`	`getParameterVersion(ParameterVersionName name)` Gets details of a single ParameterVersion.
`ParameterVersion`	`getParameterVersion(String name)` Gets details of a single ParameterVersion.
`com.google.api.gax.rpc.UnaryCallable<GetParameterVersionRequest,ParameterVersion>`	`getParameterVersionCallable()` Gets details of a single ParameterVersion.
`ParameterManagerSettings`	`getSettings()`
`ParameterManagerStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`ParameterManagerClient.ListLocationsPagedResponse`	`listLocations(com.google.cloud.location.ListLocationsRequest request)` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`	`listLocationsCallable()` Lists information about the supported locations for this service.
`com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,ParameterManagerClient.ListLocationsPagedResponse>`	`listLocationsPagedCallable()` Lists information about the supported locations for this service.
`ParameterManagerClient.ListParametersPagedResponse`	`listParameters(ListParametersRequest request)` Lists Parameters in a given project and location.
`ParameterManagerClient.ListParametersPagedResponse`	`listParameters(LocationName parent)` Lists Parameters in a given project and location.
`ParameterManagerClient.ListParametersPagedResponse`	`listParameters(String parent)` Lists Parameters in a given project and location.
`com.google.api.gax.rpc.UnaryCallable<ListParametersRequest,ListParametersResponse>`	`listParametersCallable()` Lists Parameters in a given project and location.
`com.google.api.gax.rpc.UnaryCallable<ListParametersRequest,ParameterManagerClient.ListParametersPagedResponse>`	`listParametersPagedCallable()` Lists Parameters in a given project and location.
`ParameterManagerClient.ListParameterVersionsPagedResponse`	`listParameterVersions(ListParameterVersionsRequest request)` Lists ParameterVersions in a given project, location, and parameter.
`ParameterManagerClient.ListParameterVersionsPagedResponse`	`listParameterVersions(ParameterName parent)` Lists ParameterVersions in a given project, location, and parameter.
`ParameterManagerClient.ListParameterVersionsPagedResponse`	`listParameterVersions(String parent)` Lists ParameterVersions in a given project, location, and parameter.
`com.google.api.gax.rpc.UnaryCallable<ListParameterVersionsRequest,ListParameterVersionsResponse>`	`listParameterVersionsCallable()` Lists ParameterVersions in a given project, location, and parameter.
`com.google.api.gax.rpc.UnaryCallable<ListParameterVersionsRequest,ParameterManagerClient.ListParameterVersionsPagedResponse>`	`listParameterVersionsPagedCallable()` Lists ParameterVersions in a given project, location, and parameter.
`RenderParameterVersionResponse`	`renderParameterVersion(ParameterVersionName name)` Gets rendered version of a ParameterVersion.
`RenderParameterVersionResponse`	`renderParameterVersion(RenderParameterVersionRequest request)` Gets rendered version of a ParameterVersion.
`RenderParameterVersionResponse`	`renderParameterVersion(String name)` Gets rendered version of a ParameterVersion.
`com.google.api.gax.rpc.UnaryCallable<RenderParameterVersionRequest,RenderParameterVersionResponse>`	`renderParameterVersionCallable()` Gets rendered version of a ParameterVersion.
`void`	`shutdown()`
`void`	`shutdownNow()`
`Parameter`	`updateParameter(Parameter parameter, com.google.protobuf.FieldMask updateMask)` Updates a single Parameter.
`Parameter`	`updateParameter(UpdateParameterRequest request)` Updates a single Parameter.
`com.google.api.gax.rpc.UnaryCallable<UpdateParameterRequest,Parameter>`	`updateParameterCallable()` Updates a single Parameter.
`ParameterVersion`	`updateParameterVersion(ParameterVersion parameterVersion, com.google.protobuf.FieldMask updateMask)` Updates a single ParameterVersion.
`ParameterVersion`	`updateParameterVersion(UpdateParameterVersionRequest request)` Updates a single ParameterVersion.
`com.google.api.gax.rpc.UnaryCallable<UpdateParameterVersionRequest,ParameterVersion>`	`updateParameterVersionCallable()` Updates a single ParameterVersion.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- ParameterManagerClient
```
protected ParameterManagerClient(ParameterManagerSettings settings)
                          throws IOException
```
  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.
  
  Throws:
  
  IOException
- ParameterManagerClient
```
protected ParameterManagerClient(ParameterManagerStub stub)
```

Method Detail

create

public static final ParameterManagerClient create()
                                           throws IOException

Constructs an instance of ParameterManagerClient with default settings.

Throws:: IOException

create
```
public static final ParameterManagerClient create(ParameterManagerSettings settings)
                                           throws IOException
```
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.

Throws:

IOException

create
```
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).

getSettings

public final ParameterManagerSettings getSettings()

getStub
```
public ParameterManagerStub getStub()
```