PhishingProtectionServiceV1Beta1Client (Google Cloud 0.119.0-alpha API)

java.lang.Object
- com.google.cloud.phishingprotection.v1beta1.PhishingProtectionServiceV1Beta1Client

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class PhishingProtectionServiceV1Beta1Client
extends Object
implements com.google.api.gax.core.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:
```
 
 try (PhishingProtectionServiceV1Beta1Client phishingProtectionServiceV1Beta1Client = PhishingProtectionServiceV1Beta1Client.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   String uri = "";
   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:
1. 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.
2. 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.
3. 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:
```
 
 PhishingProtectionServiceV1Beta1Settings phishingProtectionServiceV1Beta1Settings =
     PhishingProtectionServiceV1Beta1Settings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PhishingProtectionServiceV1Beta1Client phishingProtectionServiceV1Beta1Client =
     PhishingProtectionServiceV1Beta1Client.create(phishingProtectionServiceV1Beta1Settings);
 
 
```
To customize the endpoint:
```
 
 PhishingProtectionServiceV1Beta1Settings phishingProtectionServiceV1Beta1Settings =
     PhishingProtectionServiceV1Beta1Settings.newBuilder().setEndpoint(myEndpoint).build();
 PhishingProtectionServiceV1Beta1Client phishingProtectionServiceV1Beta1Client =
     PhishingProtectionServiceV1Beta1Client.create(phishingProtectionServiceV1Beta1Settings);
 
 
```

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`PhishingProtectionServiceV1Beta1Client(PhishingProtectionServiceV1Beta1Settings settings)` Constructs an instance of PhishingProtectionServiceV1Beta1Client, using the given settings.
`protected`	`PhishingProtectionServiceV1Beta1Client(PhishingProtectionServiceV1Beta1Stub 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 PhishingProtectionServiceV1Beta1Client`	`create()` Constructs an instance of PhishingProtectionServiceV1Beta1Client with default settings.
`static PhishingProtectionServiceV1Beta1Client`	`create(PhishingProtectionServiceV1Beta1Settings settings)` Constructs an instance of PhishingProtectionServiceV1Beta1Client, using the given settings.
`static PhishingProtectionServiceV1Beta1Client`	`create(PhishingProtectionServiceV1Beta1Stub stub)` Constructs an instance of PhishingProtectionServiceV1Beta1Client, using the given stub for making calls.
`PhishingProtectionServiceV1Beta1Settings`	`getSettings()`
`PhishingProtectionServiceV1Beta1Stub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`ReportPhishingResponse`	`reportPhishing(ProjectName parent, String uri)` Reports a URI suspected of containing phishing content to be reviewed.
`ReportPhishingResponse`	`reportPhishing(ReportPhishingRequest request)` Reports a URI suspected of containing phishing content to be reviewed.
`ReportPhishingResponse`	`reportPhishing(String parent, String uri)` Reports a URI suspected of containing phishing content to be reviewed.
`com.google.api.gax.rpc.UnaryCallable<ReportPhishingRequest,ReportPhishingResponse>`	`reportPhishingCallable()` Reports a URI suspected of containing phishing content to be reviewed.
`void`	`shutdown()`
`void`	`shutdownNow()`

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

- Constructor Detail
  - 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
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected PhishingProtectionServiceV1Beta1Client(PhishingProtectionServiceV1Beta1Stub stub)
```
- Method Detail
  - 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
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
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 to use PhishingProtectionServiceV1Beta1Settings}.
  - getSettings
```
public final PhishingProtectionServiceV1Beta1Settings getSettings()
```
  - getStub
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
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:
```
 try (PhishingProtectionServiceV1Beta1Client phishingProtectionServiceV1Beta1Client = PhishingProtectionServiceV1Beta1Client.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   String uri = "";
   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:
    
    com.google.api.gax.rpc.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:
```
 try (PhishingProtectionServiceV1Beta1Client phishingProtectionServiceV1Beta1Client = PhishingProtectionServiceV1Beta1Client.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   String uri = "";
   ReportPhishingResponse response = phishingProtectionServiceV1Beta1Client.reportPhishing(parent.toString(), 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:
    
    com.google.api.gax.rpc.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:
```
 try (PhishingProtectionServiceV1Beta1Client phishingProtectionServiceV1Beta1Client = PhishingProtectionServiceV1Beta1Client.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   String uri = "";
   ReportPhishingRequest request = ReportPhishingRequest.newBuilder()
     .setParent(parent.toString())
     .setUri(uri)
     .build();
   ReportPhishingResponse response = phishingProtectionServiceV1Beta1Client.reportPhishing(request);
 }
 
```
    Parameters:
    
    request - The request object containing all of the parameters for the API call.
    
    Throws:
    
    com.google.api.gax.rpc.ApiException - if the remote call fails
  - reportPhishingCallable
```
public final com.google.api.gax.rpc.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:
```
 try (PhishingProtectionServiceV1Beta1Client phishingProtectionServiceV1Beta1Client = PhishingProtectionServiceV1Beta1Client.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   String uri = "";
   ReportPhishingRequest request = ReportPhishingRequest.newBuilder()
     .setParent(parent.toString())
     .setUri(uri)
     .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 com.google.api.gax.core.BackgroundResource
  - isShutdown
```
public boolean isShutdown()
```
    Specified by:
    
    isShutdown in interface com.google.api.gax.core.BackgroundResource
  - isTerminated
```
public boolean isTerminated()
```
    Specified by:
    
    isTerminated in interface com.google.api.gax.core.BackgroundResource
  - shutdownNow
```
public void shutdownNow()
```
    Specified by:
    
    shutdownNow in interface com.google.api.gax.core.BackgroundResource
  - awaitTermination
```
public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException
```
    Specified by:
    
    awaitTermination in interface com.google.api.gax.core.BackgroundResource
    
    Throws:
    
    InterruptedException

Class PhishingProtectionServiceV1Beta1Client

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PhishingProtectionServiceV1Beta1Client

PhishingProtectionServiceV1Beta1Client

Method Detail

create

create

create

getSettings

getStub

reportPhishing

reportPhishing

reportPhishing

reportPhishingCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination