Package com.google.cloud.ids.v1 (1.2.0)

A client to Cloud IDS API

The interfaces provided are listed below, along with usage samples.

IDSClient

Service Description: The IDS Service

Sample for IDSClient:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (IDSClient iDSClient = IDSClient.create()) {
   EndpointName name = EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]");
   Endpoint response = iDSClient.getEndpoint(name);
 }

Classes

CreateEndpointRequest

Protobuf type google.cloud.ids.v1.CreateEndpointRequest

CreateEndpointRequest.Builder

Protobuf type google.cloud.ids.v1.CreateEndpointRequest

DeleteEndpointRequest

Protobuf type google.cloud.ids.v1.DeleteEndpointRequest

DeleteEndpointRequest.Builder

Protobuf type google.cloud.ids.v1.DeleteEndpointRequest

Endpoint

Endpoint describes a single IDS endpoint. It defines a forwarding rule to which packets can be sent for IDS inspection.

Protobuf type google.cloud.ids.v1.Endpoint

Endpoint.Builder

Endpoint describes a single IDS endpoint. It defines a forwarding rule to which packets can be sent for IDS inspection.

Protobuf type google.cloud.ids.v1.Endpoint

EndpointName.Builder

Builder for projects/{project}/locations/{location}/endpoints/{endpoint}.

GetEndpointRequest

Protobuf type google.cloud.ids.v1.GetEndpointRequest

GetEndpointRequest.Builder

Protobuf type google.cloud.ids.v1.GetEndpointRequest

IDSClient

Service Description: The IDS Service

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (IDSClient iDSClient = IDSClient.create()) {
   EndpointName name = EndpointName.of("[PROJECT]", "[LOCATION]", "[ENDPOINT]");
   Endpoint response = iDSClient.getEndpoint(name);
 }

Note: close() needs to be called on the IDSClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of IDSSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 IDSSettings iDSSettings =
     IDSSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 IDSClient iDSClient = IDSClient.create(iDSSettings);

To customize the endpoint:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 IDSSettings iDSSettings = IDSSettings.newBuilder().setEndpoint(myEndpoint).build();
 IDSClient iDSClient = IDSClient.create(iDSSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 IDSSettings iDSSettings =
     IDSSettings.newBuilder()
         .setTransportChannelProvider(
             IDSSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 IDSClient iDSClient = IDSClient.create(iDSSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

The default service address (ids.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getEndpoint to 30 seconds:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 IDSSettings.Builder iDSSettingsBuilder = IDSSettings.newBuilder();
 iDSSettingsBuilder
     .getEndpointSettings()
     .setRetrySettings(
         iDSSettingsBuilder
             .getEndpointSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 IDSSettings iDSSettings = iDSSettingsBuilder.build();

Enums

Endpoint.Severity

Threat severity levels.

Protobuf enum google.cloud.ids.v1.Endpoint.Severity

Endpoint.State

Endpoint state

Protobuf enum google.cloud.ids.v1.Endpoint.State

Package com.google.cloud.ids.v1 (1.2.0)

IDSClient

Classes

Interfaces

Enums