Package com.google.cloud.phishingprotection.v1beta1

Class PhishingProtectionServiceV1Beta1Client

java.lang.Object
com.google.cloud.phishingprotection.v1beta1.PhishingProtectionServiceV1Beta1Client
All Implemented Interfaces:
BackgroundResource, AutoCloseable
@BetaApi @Generated("by gapic-generator-java") public class PhishingProtectionServiceV1Beta1Client extends Object implements BackgroundResource
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().

Methods
Method Description Method Variants

ReportPhishing

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](https://support.google.com/webmasters/answer/6350487/) in order to protect users that could get exposed to this threat in the future.

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

  • reportPhishing(ReportPhishingRequest request)

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

  • reportPhishing(ProjectName parent, String uri)

  • reportPhishing(String parent, String uri)

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

  • reportPhishingCallable()

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.

  • Constructor Details

    • PhishingProtectionServiceV1Beta1Client

      protected PhishingProtectionServiceV1Beta1Client(PhishingProtectionServiceV1Beta1Settings settings) throws IOException
      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.
      Throws:
      IOException

    • PhishingProtectionServiceV1Beta1Client

      protected PhishingProtectionServiceV1Beta1Client(PhishingProtectionServiceV1Beta1Stub stub)

  • Method Details

    • create

      public static final PhishingProtectionServiceV1Beta1Client create() throws IOException
      Constructs an instance of PhishingProtectionServiceV1Beta1Client with default settings.
      Throws:
      IOException

    • create

      public static final PhishingProtectionServiceV1Beta1Client create(PhishingProtectionServiceV1Beta1Settings settings) throws IOException
      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.
      Throws:
      IOException

    • create

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

    • getSettings

      public final PhishingProtectionServiceV1Beta1Settings getSettings()

    • getStub

      public PhishingProtectionServiceV1Beta1Stub getStub()

    • reportPhishing

      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](https://support.google.com/webmasters/answer/6350487/) 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:
      parent - Required. The name of the project for which the report will be created, in the format "projects/{project_number}".
      uri - Required. The URI that is being reported for phishing content to be analyzed.
      Throws:
      ApiException - if the remote call fails

    • reportPhishing

      public final ReportPhishingResponse reportPhishing(String 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](https://support.google.com/webmasters/answer/6350487/) 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()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   String uri = "uri116076";
   ReportPhishingResponse response =
       phishingProtectionServiceV1Beta1Client.reportPhishing(parent, uri);
 }
      Parameters:
      parent - Required. The name of the project for which the report will be created, in the format "projects/{project_number}".
      uri - Required. The URI that is being reported for phishing content to be analyzed.
      Throws:
      ApiException - if the remote call fails

    • reportPhishing

      public final ReportPhishingResponse reportPhishing(ReportPhishingRequest request)
      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](https://support.google.com/webmasters/answer/6350487/) 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()) {
   ReportPhishingRequest request =
       ReportPhishingRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setUri("uri116076")
           .build();
   ReportPhishingResponse response =
       phishingProtectionServiceV1Beta1Client.reportPhishing(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • reportPhishingCallable

      public final UnaryCallable<ReportPhishingRequest,ReportPhishingResponse> reportPhishingCallable()
      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](https://support.google.com/webmasters/answer/6350487/) 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()) {
   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();
 }

    • close

      public final void close()
      Specified by:
      close in interface AutoCloseable

    • shutdown

      public void shutdown()
      Specified by:
      shutdown in interface BackgroundResource

    • isShutdown

      public boolean isShutdown()
      Specified by:
      isShutdown in interface BackgroundResource

    • isTerminated

      public boolean isTerminated()
      Specified by:
      isTerminated in interface BackgroundResource

    • shutdownNow

      public void shutdownNow()
      Specified by:
      shutdownNow in interface BackgroundResource

    • awaitTermination

      public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
      Specified by:
      awaitTermination in interface BackgroundResource
      Throws:
      InterruptedException