Skip to content

Commit 7b5b006

Browse files
yoshi-automationtseaver
yoshi-automation
authored and
tseaver
committed
docs(phishingprotection): update docstrings (via synth) (googleapis#9350)
1 parent bbd09fd commit 7b5b006

6 files changed

Lines changed: 72 additions & 40 deletions

File tree

‎phishingprotection/google/cloud/phishingprotection_v1beta1/gapic/phishing_protection_service_client.py‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -206,9 +206,10 @@ def report_phishing(
206206
):
207207
"""
208208
Reports a URI suspected of containing phishing content to be reviewed.
209-
Once the report review is completed, if its result verifies the
210-
existince of malicious phishing content, the site will be added the to
211-
`Google's Social Engineering
209+
Once the report review is complete, its result can be found in the Cloud
210+
Security Command Center findings dashboard for Phishing Protection. If
211+
the result verifies the existence of malicious phishing content, the
212+
site will be added the to `Google's Social Engineering
212213
lists <https://support.google.com/webmasters/answer/6350487/>`__ in
213214
order to protect users that could get exposed to this threat in the
214215
future.
@@ -228,7 +229,7 @@ def report_phishing(
228229
Args:
229230
parent (str): Required. The name of the project for which the report will be created,
230231
in the format "projects/{project\_number}".
231-
uri (str): The URI that is being reported for phishing content to be analyzed.
232+
uri (str): Required. The URI that is being reported for phishing content to be analyzed.
232233
retry (Optional[google.api_core.retry.Retry]): A retry object used
233234
to retry requests. If ``None`` is specified, requests will
234235
be retried using a default configuration.

‎phishingprotection/google/cloud/phishingprotection_v1beta1/gapic/transports/phishing_protection_service_grpc_transport.py‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -117,9 +117,10 @@ def report_phishing(self):
117117
"""Return the gRPC stub for :meth:`PhishingProtectionServiceClient.report_phishing`.
118118
119119
Reports a URI suspected of containing phishing content to be reviewed.
120-
Once the report review is completed, if its result verifies the
121-
existince of malicious phishing content, the site will be added the to
122-
`Google's Social Engineering
120+
Once the report review is complete, its result can be found in the Cloud
121+
Security Command Center findings dashboard for Phishing Protection. If
122+
the result verifies the existence of malicious phishing content, the
123+
site will be added the to `Google's Social Engineering
123124
lists <https://support.google.com/webmasters/answer/6350487/>`__ in
124125
order to protect users that could get exposed to this threat in the
125126
future.

‎phishingprotection/google/cloud/phishingprotection_v1beta1/proto/phishingprotection.proto‎

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ syntax = "proto3";
1818
package google.cloud.phishingprotection.v1beta1;
1919

2020
import "google/api/annotations.proto";
21+
import "google/api/client.proto";
22+
import "google/api/field_behavior.proto";
23+
import "google/api/resource.proto";
2124

2225
option csharp_namespace = "Google.Cloud.PhishingProtection.V1Beta1";
2326
option go_package = "google.golang.org/genproto/googleapis/cloud/phishingprotection/v1beta1;phishingprotection";
@@ -29,29 +32,41 @@ option php_namespace = "Google\\Cloud\\PhishingProtection\\V1beta1";
2932

3033
// Service to report phishing URIs.
3134
service PhishingProtectionServiceV1Beta1 {
35+
option (google.api.default_host) = "phishingprotection.googleapis.com";
36+
option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
37+
3238
// Reports a URI suspected of containing phishing content to be reviewed. Once
33-
// the report review is completed, if its result verifies the existince of
34-
// malicious phishing content, the site will be added the to [Google's Social
35-
// Engineering lists](https://support.google.com/webmasters/answer/6350487/)
36-
// in order to protect users that could get exposed to this threat in
37-
// the future.
39+
// the report review is complete, its result can be found in the Cloud
40+
// Security Command Center findings dashboard for Phishing Protection. If the
41+
// result verifies the existence of malicious phishing content, the site will
42+
// be added the to [Google's Social Engineering
43+
// lists](https://support.google.com/webmasters/answer/6350487/) in order to
44+
// protect users that could get exposed to this threat in the future.
3845
rpc ReportPhishing(ReportPhishingRequest) returns (ReportPhishingResponse) {
3946
option (google.api.http) = {
4047
post: "/v1beta1/{parent=projects/*}/phishing:report"
4148
body: "*"
4249
};
50+
option (google.api.method_signature) = "parent,uri";
4351
}
4452
}
4553

4654
// The ReportPhishing request message.
4755
message ReportPhishingRequest {
4856
// Required. The name of the project for which the report will be created,
4957
// in the format "projects/{project_number}".
50-
string parent = 1;
58+
string parent = 1 [
59+
(google.api.field_behavior) = REQUIRED,
60+
(google.api.resource_reference) = {
61+
type: "cloudresourcemanager.googleapis.com/Project"
62+
}
63+
];
5164

52-
// The URI that is being reported for phishing content to be analyzed.
53-
string uri = 2;
65+
// Required. The URI that is being reported for phishing content to be analyzed.
66+
string uri = 2 [(google.api.field_behavior) = REQUIRED];
5467
}
5568

5669
// The ReportPhishing (empty) response message.
57-
message ReportPhishingResponse {}
70+
message ReportPhishingResponse {
71+
72+
}

‎phishingprotection/google/cloud/phishingprotection_v1beta1/proto/phishingprotection_pb2.py‎

Lines changed: 28 additions & 14 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎phishingprotection/google/cloud/phishingprotection_v1beta1/proto/phishingprotection_pb2_grpc.py‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,12 @@ class PhishingProtectionServiceV1Beta1Servicer(object):
2929

3030
def ReportPhishing(self, request, context):
3131
"""Reports a URI suspected of containing phishing content to be reviewed. Once
32-
the report review is completed, if its result verifies the existince of
33-
malicious phishing content, the site will be added the to [Google's Social
34-
Engineering lists](https://support.google.com/webmasters/answer/6350487/)
35-
in order to protect users that could get exposed to this threat in
36-
the future.
32+
the report review is complete, its result can be found in the Cloud
33+
Security Command Center findings dashboard for Phishing Protection. If the
34+
result verifies the existence of malicious phishing content, the site will
35+
be added the to [Google's Social Engineering
36+
lists](https://support.google.com/webmasters/answer/6350487/) in order to
37+
protect users that could get exposed to this threat in the future.
3738
"""
3839
context.set_code(grpc.StatusCode.UNIMPLEMENTED)
3940
context.set_details("Method not implemented!")

‎phishingprotection/synth.metadata‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
{
2-
"updateTime": "2019-08-06T12:33:35.867649Z",
2+
"updateTime": "2019-09-28T12:31:47.480388Z",
33
"sources": [
44
{
55
"generator": {
66
"name": "artman",
7-
"version": "0.32.1",
8-
"dockerImage": "googleapis/artman@sha256:a684d40ba9a4e15946f5f2ca6b4bd9fe301192f522e9de4fff622118775f309b"
7+
"version": "0.37.1",
8+
"dockerImage": "googleapis/artman@sha256:6068f67900a3f0bdece596b97bda8fc70406ca0e137a941f4c81d3217c994a80"
99
}
1010
},
1111
{
1212
"git": {
1313
"name": "googleapis",
1414
"remote": "https://github.com/googleapis/googleapis.git",
15-
"sha": "e699b0cba64ffddfae39633417180f1f65875896",
16-
"internalRef": "261759677"
15+
"sha": "fcdec366bb4076be75649031706548128a01fc02",
16+
"internalRef": "271635926"
1717
}
1818
},
1919
{

0 commit comments

Comments
 (0)