Cloud Phishing Protection v1beta1 API - Class PhishingProtectionServiceV1Beta1Client (2.0.0-beta04)

Version latest

• 2.0.0-beta04 (latest)
• 2.0.0-beta03
• 1.0.0-beta05

public abstract class PhishingProtectionServiceV1Beta1Client

Reference documentation and code samples for the Cloud Phishing Protection v1beta1 API class PhishingProtectionServiceV1Beta1Client.

PhishingProtectionServiceV1Beta1 client wrapper, for convenient use.

Inheritance

object > PhishingProtectionServiceV1Beta1Client

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

PhishingProtectionServiceV1Beta1ClientImpl

Namespace

Google.Cloud.PhishingProtection.V1Beta1

Assembly

Google.Cloud.PhishingProtection.V1Beta1.dll

Remarks

Service to report phishing URIs.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the PhishingProtectionServiceV1Beta1 service, which is a host of "phishingprotection.googleapis.com" and a port of 443.

Property Value
Type	Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default PhishingProtectionServiceV1Beta1 scopes.

Property Value
Type	Description
IReadOnlyListstring

Remarks

The default PhishingProtectionServiceV1Beta1 scopes are:

• https://www.googleapis.com/auth/cloud-platform

GrpcClient

public virtual PhishingProtectionServiceV1Beta1.PhishingProtectionServiceV1Beta1Client GrpcClient { get; }

The underlying gRPC PhishingProtectionServiceV1Beta1 client

Property Value
Type	Description
PhishingProtectionServiceV1Beta1PhishingProtectionServiceV1Beta1Client

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
ServiceMetadata

Methods

Create()

public static PhishingProtectionServiceV1Beta1Client Create()

Synchronously creates a PhishingProtectionServiceV1Beta1Client using the default credentials, endpoint and settings. To specify custom credentials or other settings, use PhishingProtectionServiceV1Beta1ClientBuilder.

Returns
Type	Description
PhishingProtectionServiceV1Beta1Client	The created PhishingProtectionServiceV1Beta1Client.

CreateAsync(CancellationToken)

public static Task<PhishingProtectionServiceV1Beta1Client> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a PhishingProtectionServiceV1Beta1Client using the default credentials, endpoint and settings. To specify custom credentials or other settings, use PhishingProtectionServiceV1Beta1ClientBuilder.

Parameter
Name	Description
cancellationToken	CancellationToken The CancellationToken to use while creating the client.

Returns
Type	Description
TaskPhishingProtectionServiceV1Beta1Client	The task representing the created PhishingProtectionServiceV1Beta1Client.

ReportPhishing(ProjectName, string, CallSettings)

public virtual ReportPhishingResponse ReportPhishing(ProjectName parent, string uri, CallSettings callSettings = null)

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.

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.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ReportPhishingResponse	The RPC response.

Example

// Create client
PhishingProtectionServiceV1Beta1Client phishingProtectionServiceV1Beta1Client = PhishingProtectionServiceV1Beta1Client.Create();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
string uri = "";
// Make the request
ReportPhishingResponse response = phishingProtectionServiceV1Beta1Client.ReportPhishing(parent, uri);

ReportPhishing(ReportPhishingRequest, CallSettings)

public virtual ReportPhishingResponse ReportPhishing(ReportPhishingRequest request, CallSettings callSettings = null)

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.

Parameters
Name	Description
request	ReportPhishingRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ReportPhishingResponse	The RPC response.

Example

// Create client
PhishingProtectionServiceV1Beta1Client phishingProtectionServiceV1Beta1Client = PhishingProtectionServiceV1Beta1Client.Create();
// Initialize request argument(s)
ReportPhishingRequest request = new ReportPhishingRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Uri = "",
};
// Make the request
ReportPhishingResponse response = phishingProtectionServiceV1Beta1Client.ReportPhishing(request);

ReportPhishing(string, string, CallSettings)

public virtual ReportPhishingResponse ReportPhishing(string parent, string uri, CallSettings callSettings = null)

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.

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.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ReportPhishingResponse	The RPC response.

Example

// Create client
PhishingProtectionServiceV1Beta1Client phishingProtectionServiceV1Beta1Client = PhishingProtectionServiceV1Beta1Client.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
string uri = "";
// Make the request
ReportPhishingResponse response = phishingProtectionServiceV1Beta1Client.ReportPhishing(parent, uri);

ReportPhishingAsync(ProjectName, string, CallSettings)

public virtual Task<ReportPhishingResponse> ReportPhishingAsync(ProjectName parent, string uri, CallSettings callSettings = null)

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.

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.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskReportPhishingResponse	A Task containing the RPC response.

Example

// Create client
PhishingProtectionServiceV1Beta1Client phishingProtectionServiceV1Beta1Client = await PhishingProtectionServiceV1Beta1Client.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
string uri = "";
// Make the request
ReportPhishingResponse response = await phishingProtectionServiceV1Beta1Client.ReportPhishingAsync(parent, uri);

ReportPhishingAsync(ProjectName, string, CancellationToken)

public virtual Task<ReportPhishingResponse> ReportPhishingAsync(ProjectName parent, string uri, CancellationToken cancellationToken)

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.

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.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskReportPhishingResponse	A Task containing the RPC response.

Example

// Create client
PhishingProtectionServiceV1Beta1Client phishingProtectionServiceV1Beta1Client = await PhishingProtectionServiceV1Beta1Client.CreateAsync();
// Initialize request argument(s)
ProjectName parent = ProjectName.FromProject("[PROJECT]");
string uri = "";
// Make the request
ReportPhishingResponse response = await phishingProtectionServiceV1Beta1Client.ReportPhishingAsync(parent, uri);

ReportPhishingAsync(ReportPhishingRequest, CallSettings)

public virtual Task<ReportPhishingResponse> ReportPhishingAsync(ReportPhishingRequest request, CallSettings callSettings = null)

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.

Parameters
Name	Description
request	ReportPhishingRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskReportPhishingResponse	A Task containing the RPC response.

Example

// Create client
PhishingProtectionServiceV1Beta1Client phishingProtectionServiceV1Beta1Client = await PhishingProtectionServiceV1Beta1Client.CreateAsync();
// Initialize request argument(s)
ReportPhishingRequest request = new ReportPhishingRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Uri = "",
};
// Make the request
ReportPhishingResponse response = await phishingProtectionServiceV1Beta1Client.ReportPhishingAsync(request);

ReportPhishingAsync(ReportPhishingRequest, CancellationToken)

public virtual Task<ReportPhishingResponse> ReportPhishingAsync(ReportPhishingRequest request, CancellationToken cancellationToken)

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.

Parameters
Name	Description
request	ReportPhishingRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskReportPhishingResponse	A Task containing the RPC response.

Example

// Create client
PhishingProtectionServiceV1Beta1Client phishingProtectionServiceV1Beta1Client = await PhishingProtectionServiceV1Beta1Client.CreateAsync();
// Initialize request argument(s)
ReportPhishingRequest request = new ReportPhishingRequest
{
    ParentAsProjectName = ProjectName.FromProject("[PROJECT]"),
    Uri = "",
};
// Make the request
ReportPhishingResponse response = await phishingProtectionServiceV1Beta1Client.ReportPhishingAsync(request);

ReportPhishingAsync(string, string, CallSettings)

public virtual Task<ReportPhishingResponse> ReportPhishingAsync(string parent, string uri, CallSettings callSettings = null)

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.

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.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskReportPhishingResponse	A Task containing the RPC response.

Example

// Create client
PhishingProtectionServiceV1Beta1Client phishingProtectionServiceV1Beta1Client = await PhishingProtectionServiceV1Beta1Client.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
string uri = "";
// Make the request
ReportPhishingResponse response = await phishingProtectionServiceV1Beta1Client.ReportPhishingAsync(parent, uri);

ReportPhishingAsync(string, string, CancellationToken)

public virtual Task<ReportPhishingResponse> ReportPhishingAsync(string parent, string uri, CancellationToken cancellationToken)

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.

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.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskReportPhishingResponse	A Task containing the RPC response.

Example

// Create client
PhishingProtectionServiceV1Beta1Client phishingProtectionServiceV1Beta1Client = await PhishingProtectionServiceV1Beta1Client.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]";
string uri = "";
// Make the request
ReportPhishingResponse response = await phishingProtectionServiceV1Beta1Client.ReportPhishingAsync(parent, uri);

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type	Description
Task	A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.