ModelArmorClient (Google Model Armor API 0.23.0 API)

java.lang.Object
- com.google.cloud.modelarmor.v1beta.ModelArmorClient

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

@BetaApi
 @Generated(value="by gapic-generator-java")
public class ModelArmorClient
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 (ModelArmorClient modelArmorClient = ModelArmorClient.create()) {
   TemplateName name = TemplateName.of("[PROJECT]", "[LOCATION]", "[TEMPLATE]");
   Template response = modelArmorClient.getTemplate(name);
 }

Note: close() needs to be called on the ModelArmorClient 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
ListTemplates	Lists Templates in a given project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listTemplates(ListTemplatesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listTemplates(LocationName parent) listTemplates(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. listTemplatesPagedCallable() listTemplatesCallable()
GetTemplate	Gets details of a single Template.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getTemplate(GetTemplateRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getTemplate(TemplateName name) getTemplate(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. getTemplateCallable()
CreateTemplate	Creates a new Template in a given project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createTemplate(CreateTemplateRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createTemplate(LocationName parent, Template template, String templateId) createTemplate(String parent, Template template, String templateId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createTemplateCallable()
UpdateTemplate	Updates the parameters of a single Template.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateTemplate(UpdateTemplateRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateTemplate(Template template, 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. updateTemplateCallable()
DeleteTemplate	Deletes a single Template.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteTemplate(DeleteTemplateRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteTemplate(TemplateName name) deleteTemplate(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. deleteTemplateCallable()
GetFloorSetting	Gets details of a single floor setting of a project	Request object method variants only take one parameter, a request object, which must be constructed before the call. getFloorSetting(GetFloorSettingRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getFloorSetting(FloorSettingName name) getFloorSetting(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. getFloorSettingCallable()
UpdateFloorSetting	Updates the parameters of a single floor setting of a project	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateFloorSetting(UpdateFloorSettingRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateFloorSetting(FloorSetting floorSetting, 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. updateFloorSettingCallable()
SanitizeUserPrompt	Sanitizes User Prompt.	Request object method variants only take one parameter, a request object, which must be constructed before the call. sanitizeUserPrompt(SanitizeUserPromptRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. sanitizeUserPromptCallable()
SanitizeModelResponse	Sanitizes Model Response.	Request object method variants only take one parameter, a request object, which must be constructed before the call. sanitizeModelResponse(SanitizeModelResponseRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. sanitizeModelResponseCallable()
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 ModelArmorSettings 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
 ModelArmorSettings modelArmorSettings =
     ModelArmorSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ModelArmorClient modelArmorClient = ModelArmorClient.create(modelArmorSettings);

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
 ModelArmorSettings modelArmorSettings =
     ModelArmorSettings.newBuilder().setEndpoint(myEndpoint).build();
 ModelArmorClient modelArmorClient = ModelArmorClient.create(modelArmorSettings);

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
 ModelArmorSettings modelArmorSettings = ModelArmorSettings.newHttpJsonBuilder().build();
 ModelArmorClient modelArmorClient = ModelArmorClient.create(modelArmorSettings);

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`	`ModelArmorClient.ListLocationsFixedSizeCollection`
`static class`	`ModelArmorClient.ListLocationsPage`
`static class`	`ModelArmorClient.ListLocationsPagedResponse`
`static class`	`ModelArmorClient.ListTemplatesFixedSizeCollection`
`static class`	`ModelArmorClient.ListTemplatesPage`
`static class`	`ModelArmorClient.ListTemplatesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ModelArmorClient(ModelArmorSettings settings)` Constructs an instance of ModelArmorClient, using the given settings.
`protected`	`ModelArmorClient(ModelArmorStub 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 ModelArmorClient`	`create()` Constructs an instance of ModelArmorClient with default settings.
`static ModelArmorClient`	`create(ModelArmorSettings settings)` Constructs an instance of ModelArmorClient, using the given settings.
`static ModelArmorClient`	`create(ModelArmorStub stub)` Constructs an instance of ModelArmorClient, using the given stub for making calls.
`Template`	`createTemplate(CreateTemplateRequest request)` Creates a new Template in a given project and location.
`Template`	`createTemplate(LocationName parent, Template template, String templateId)` Creates a new Template in a given project and location.
`Template`	`createTemplate(String parent, Template template, String templateId)` Creates a new Template in a given project and location.
`com.google.api.gax.rpc.UnaryCallable<CreateTemplateRequest,Template>`	`createTemplateCallable()` Creates a new Template in a given project and location.
`void`	`deleteTemplate(DeleteTemplateRequest request)` Deletes a single Template.
`void`	`deleteTemplate(String name)` Deletes a single Template.
`void`	`deleteTemplate(TemplateName name)` Deletes a single Template.
`com.google.api.gax.rpc.UnaryCallable<DeleteTemplateRequest,com.google.protobuf.Empty>`	`deleteTemplateCallable()` Deletes a single Template.
`FloorSetting`	`getFloorSetting(FloorSettingName name)` Gets details of a single floor setting of a project 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 (ModelArmorClient modelArmorClient = ModelArmorClient.create()) { FloorSettingName name = FloorSettingName.ofProjectLocationName("[PROJECT]", "[LOCATION]"); FloorSetting response = modelArmorClient.getFloorSetting(name); }
`FloorSetting`	`getFloorSetting(GetFloorSettingRequest request)` Gets details of a single floor setting of a project 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 (ModelArmorClient modelArmorClient = ModelArmorClient.create()) { GetFloorSettingRequest request = GetFloorSettingRequest.newBuilder() .setName(FloorSettingName.ofProjectLocationName("[PROJECT]", "[LOCATION]").toString()) .build(); FloorSetting response = modelArmorClient.getFloorSetting(request); }
`FloorSetting`	`getFloorSetting(String name)` Gets details of a single floor setting of a project 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 (ModelArmorClient modelArmorClient = ModelArmorClient.create()) { String name = FloorSettingName.ofProjectLocationName("[PROJECT]", "[LOCATION]").toString(); FloorSetting response = modelArmorClient.getFloorSetting(name); }
`com.google.api.gax.rpc.UnaryCallable<GetFloorSettingRequest,FloorSetting>`	`getFloorSettingCallable()` Gets details of a single floor setting of a project Sample code: {@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 (ModelArmorClient modelArmorClient = ModelArmorClient.create()) { GetFloorSettingRequest request = GetFloorSettingRequest.newBuilder() .setName(FloorSettingName.ofProjectLocationName("[PROJECT]", "[LOCATION]").toString()) .build(); ApiFuture future = modelArmorClient.getFloorSettingCallable().futureCall(request); // Do something.
`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.
`ModelArmorSettings`	`getSettings()`
`ModelArmorStub`	`getStub()`
`Template`	`getTemplate(GetTemplateRequest request)` Gets details of a single Template.
`Template`	`getTemplate(String name)` Gets details of a single Template.
`Template`	`getTemplate(TemplateName name)` Gets details of a single Template.
`com.google.api.gax.rpc.UnaryCallable<GetTemplateRequest,Template>`	`getTemplateCallable()` Gets details of a single Template.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`ModelArmorClient.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,ModelArmorClient.ListLocationsPagedResponse>`	`listLocationsPagedCallable()` Lists information about the supported locations for this service.
`ModelArmorClient.ListTemplatesPagedResponse`	`listTemplates(ListTemplatesRequest request)` Lists Templates in a given project and location.
`ModelArmorClient.ListTemplatesPagedResponse`	`listTemplates(LocationName parent)` Lists Templates in a given project and location.
`ModelArmorClient.ListTemplatesPagedResponse`	`listTemplates(String parent)` Lists Templates in a given project and location.
`com.google.api.gax.rpc.UnaryCallable<ListTemplatesRequest,ListTemplatesResponse>`	`listTemplatesCallable()` Lists Templates in a given project and location.
`com.google.api.gax.rpc.UnaryCallable<ListTemplatesRequest,ModelArmorClient.ListTemplatesPagedResponse>`	`listTemplatesPagedCallable()` Lists Templates in a given project and location.
`SanitizeModelResponseResponse`	`sanitizeModelResponse(SanitizeModelResponseRequest request)` Sanitizes Model Response.
`com.google.api.gax.rpc.UnaryCallable<SanitizeModelResponseRequest,SanitizeModelResponseResponse>`	`sanitizeModelResponseCallable()` Sanitizes Model Response.
`SanitizeUserPromptResponse`	`sanitizeUserPrompt(SanitizeUserPromptRequest request)` Sanitizes User Prompt.
`com.google.api.gax.rpc.UnaryCallable<SanitizeUserPromptRequest,SanitizeUserPromptResponse>`	`sanitizeUserPromptCallable()` Sanitizes User Prompt.
`void`	`shutdown()`
`void`	`shutdownNow()`
`FloorSetting`	`updateFloorSetting(FloorSetting floorSetting, com.google.protobuf.FieldMask updateMask)` Updates the parameters of a single floor setting of a project 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 (ModelArmorClient modelArmorClient = ModelArmorClient.create()) { FloorSetting floorSetting = FloorSetting.newBuilder().build(); FieldMask updateMask = FieldMask.newBuilder().build(); FloorSetting response = modelArmorClient.updateFloorSetting(floorSetting, updateMask); }
`FloorSetting`	`updateFloorSetting(UpdateFloorSettingRequest request)` Updates the parameters of a single floor setting of a project 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 (ModelArmorClient modelArmorClient = ModelArmorClient.create()) { UpdateFloorSettingRequest request = UpdateFloorSettingRequest.newBuilder() .setFloorSetting(FloorSetting.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); FloorSetting response = modelArmorClient.updateFloorSetting(request); }
`com.google.api.gax.rpc.UnaryCallable<UpdateFloorSettingRequest,FloorSetting>`	`updateFloorSettingCallable()` Updates the parameters of a single floor setting of a project Sample code: {@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 (ModelArmorClient modelArmorClient = ModelArmorClient.create()) { UpdateFloorSettingRequest request = UpdateFloorSettingRequest.newBuilder() .setFloorSetting(FloorSetting.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); ApiFuture future = modelArmorClient.updateFloorSettingCallable().futureCall(request); // Do something.
`Template`	`updateTemplate(Template template, com.google.protobuf.FieldMask updateMask)` Updates the parameters of a single Template.
`Template`	`updateTemplate(UpdateTemplateRequest request)` Updates the parameters of a single Template.
`com.google.api.gax.rpc.UnaryCallable<UpdateTemplateRequest,Template>`	`updateTemplateCallable()` Updates the parameters of a single Template.

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

Constructor Detail
- ModelArmorClient
```
protected ModelArmorClient(ModelArmorSettings settings)
                    throws IOException
```
  Constructs an instance of ModelArmorClient, 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
- ModelArmorClient
```
protected ModelArmorClient(ModelArmorStub stub)
```

Method Detail

create

public static final ModelArmorClient create()
                                     throws IOException

Constructs an instance of ModelArmorClient with default settings.

Throws:: IOException

create
```
public static final ModelArmorClient create(ModelArmorSettings settings)
                                     throws IOException
```
Constructs an instance of ModelArmorClient, 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 ModelArmorClient create(ModelArmorStub stub)
```
Constructs an instance of ModelArmorClient, using the given stub for making calls. This is for advanced usage - prefer using create(ModelArmorSettings).

getSettings

public final ModelArmorSettings getSettings()

getStub
```
public ModelArmorStub getStub()
```