Class PhishingProtectionServiceV1Beta1Client (0.61.0)

Service Description: Service to report phishing URIs.

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 (PhishingProtectionServiceV1Beta1Client phishingProtectionServiceV1Beta1Client =
     PhishingProtectionServiceV1Beta1Client.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   String uri = "uri116076";
   ReportPhishingResponse response =
       phishingProtectionServiceV1Beta1Client.reportPhishing(parent, uri);
 }

Note: close() needs to be called on the PhishingProtectionServiceV1Beta1Client 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 PhishingProtectionServiceV1Beta1Settings 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
 PhishingProtectionServiceV1Beta1Settings phishingProtectionServiceV1Beta1Settings =
     PhishingProtectionServiceV1Beta1Settings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PhishingProtectionServiceV1Beta1Client phishingProtectionServiceV1Beta1Client =
     PhishingProtectionServiceV1Beta1Client.create(phishingProtectionServiceV1Beta1Settings);

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
 PhishingProtectionServiceV1Beta1Settings phishingProtectionServiceV1Beta1Settings =
     PhishingProtectionServiceV1Beta1Settings.newBuilder().setEndpoint(myEndpoint).build();
 PhishingProtectionServiceV1Beta1Client phishingProtectionServiceV1Beta1Client =
     PhishingProtectionServiceV1Beta1Client.create(phishingProtectionServiceV1Beta1Settings);

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
 PhishingProtectionServiceV1Beta1Settings phishingProtectionServiceV1Beta1Settings =
     PhishingProtectionServiceV1Beta1Settings.newHttpJsonBuilder().build();
 PhishingProtectionServiceV1Beta1Client phishingProtectionServiceV1Beta1Client =
     PhishingProtectionServiceV1Beta1Client.create(phishingProtectionServiceV1Beta1Settings);

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

Inheritance

java.lang.Object > PhishingProtectionServiceV1Beta1Client

Static Methods

create()

public static final PhishingProtectionServiceV1Beta1Client create()

Constructs an instance of PhishingProtectionServiceV1Beta1Client with default settings.

Returns
Type	Description
`PhishingProtectionServiceV1Beta1Client`

Exceptions
Type	Description
`IOException`

create(PhishingProtectionServiceV1Beta1Settings settings)

public static final PhishingProtectionServiceV1Beta1Client create(PhishingProtectionServiceV1Beta1Settings settings)

Constructs an instance of PhishingProtectionServiceV1Beta1Client, 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`	`PhishingProtectionServiceV1Beta1Settings`

Returns
Type	Description
`PhishingProtectionServiceV1Beta1Client`

Exceptions
Type	Description
`IOException`

create(PhishingProtectionServiceV1Beta1Stub stub)

public static final PhishingProtectionServiceV1Beta1Client create(PhishingProtectionServiceV1Beta1Stub stub)

Constructs an instance of PhishingProtectionServiceV1Beta1Client, using the given stub for making calls. This is for advanced usage - prefer using create(PhishingProtectionServiceV1Beta1Settings).

Parameter
Name	Description
`stub`	`PhishingProtectionServiceV1Beta1Stub`

Returns
Type	Description
`PhishingProtectionServiceV1Beta1Client`

Constructors

PhishingProtectionServiceV1Beta1Client(PhishingProtectionServiceV1Beta1Settings settings)

protected PhishingProtectionServiceV1Beta1Client(PhishingProtectionServiceV1Beta1Settings settings)

Constructs an instance of PhishingProtectionServiceV1Beta1Client, 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`	`PhishingProtectionServiceV1Beta1Settings`

PhishingProtectionServiceV1Beta1Client(PhishingProtectionServiceV1Beta1Stub stub)

protected PhishingProtectionServiceV1Beta1Client(PhishingProtectionServiceV1Beta1Stub stub)

Parameter
Name	Description
`stub`	`PhishingProtectionServiceV1Beta1Stub`

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

getSettings()

public final PhishingProtectionServiceV1Beta1Settings getSettings()

Returns
Type	Description
`PhishingProtectionServiceV1Beta1Settings`

getStub()

public PhishingProtectionServiceV1Beta1Stub getStub()

Returns
Type	Description
`PhishingProtectionServiceV1Beta1Stub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

reportPhishing(ProjectName parent, String uri)

public final ReportPhishingResponse reportPhishing(ProjectName parent, String uri)

Reports a URI suspected of containing phishing content to be reviewed. Once the report review is complete, its result can be found in the Cloud Security Command Center findings dashboard for Phishing Protection. If the result verifies the existence of malicious phishing content, the site will be added the to Google's Social Engineering lists in order to protect users that could get exposed to this threat in the future.

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 (PhishingProtectionServiceV1Beta1Client phishingProtectionServiceV1Beta1Client =
     PhishingProtectionServiceV1Beta1Client.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   String uri = "uri116076";
   ReportPhishingResponse response =
       phishingProtectionServiceV1Beta1Client.reportPhishing(parent, uri);
 }

Parameters
Name	Description
`parent`	`ProjectName` Required. The name of the project for which the report will be created, in the format "projects/{project_number}".
`uri`	`String` Required. The URI that is being reported for phishing content to be analyzed.

Returns
Type	Description
`ReportPhishingResponse`

reportPhishing(ReportPhishingRequest request)

public final ReportPhishingResponse reportPhishing(ReportPhishingRequest request)

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 (PhishingProtectionServiceV1Beta1Client phishingProtectionServiceV1Beta1Client =
     PhishingProtectionServiceV1Beta1Client.create()) {
   ReportPhishingRequest request =
       ReportPhishingRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setUri("uri116076")
           .build();
   ReportPhishingResponse response =
       phishingProtectionServiceV1Beta1Client.reportPhishing(request);
 }

Parameter
Name	Description
`request`	`ReportPhishingRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`ReportPhishingResponse`

reportPhishing(String parent, String uri)

public final ReportPhishingResponse reportPhishing(String parent, String uri)

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 (PhishingProtectionServiceV1Beta1Client phishingProtectionServiceV1Beta1Client =
     PhishingProtectionServiceV1Beta1Client.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   String uri = "uri116076";
   ReportPhishingResponse response =
       phishingProtectionServiceV1Beta1Client.reportPhishing(parent, uri);
 }

Parameters
Name	Description
`parent`	`String` Required. The name of the project for which the report will be created, in the format "projects/{project_number}".
`uri`	`String` Required. The URI that is being reported for phishing content to be analyzed.

Returns
Type	Description
`ReportPhishingResponse`

reportPhishingCallable()

public final UnaryCallable<ReportPhishingRequest,ReportPhishingResponse> reportPhishingCallable()

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 (PhishingProtectionServiceV1Beta1Client phishingProtectionServiceV1Beta1Client =
     PhishingProtectionServiceV1Beta1Client.create()) {
   ReportPhishingRequest request =
       ReportPhishingRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setUri("uri116076")
           .build();
   ApiFuture<ReportPhishingResponse> future =
       phishingProtectionServiceV1Beta1Client.reportPhishingCallable().futureCall(request);
   // Do something.
   ReportPhishingResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<ReportPhishingRequest,ReportPhishingResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()