Close httplib2 connections.
generate(parent, body=None, x__xgafv=None)
Uploads the results of local Code Compliance analysis and generates a scan of privacy issues. Returns a google.longrunning.Operation containing analysis and findings.
Gets a repo scan. By default, only the name and results_uri fields are returned. You can include other fields by listing them in the `fields` URL query parameter. For example, `?fields=name,sources` will return the name and sources fields.
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists repo scans for the specified repo.
Retrieves the next page of results.
close()
Close httplib2 connections.
generate(parent, body=None, x__xgafv=None)
Uploads the results of local Code Compliance analysis and generates a scan of privacy issues. Returns a google.longrunning.Operation containing analysis and findings.
Args:
parent: string, Required. Resource name of the repo. Example: `accounts/123/repos/456` (required)
body: object, The request body.
The object takes the form of:
{ # The request message for RepoScanService.GenerateScan.
"cliAnalysis": { # The results of a Code Compliance CLI analysis. # Required. CLI analysis results.
"codeScans": [ # Optional. Requested code scans resulting from preliminary CLI analysis.
{ # A requested analysis of source code. Contains the source code and processing state.
"dataTypeClassifications": [ # Optional. Data type classification requests.
{ # A request to classify data types.
"dataType": "A String", # Required. Candidate data type.
"lineNumber": 42, # Required. Line number (1-based).
},
],
"sourceCode": { # Contains source code from a repo. # Required. Source code to analyze.
"code": "A String", # Required. Source code.
"endLine": 42, # Required. End line number (1-based).
"path": "A String", # Required. Path of the file.
"startLine": 42, # Required. Start line number (1-based).
},
},
],
"sources": [ # Optional. Data sources detected in the scan.
{ # Represents a data source finding.
"codeAttribution": { # Source code attribution. # Optional. Source code attribution for the finding.
"codeExcerpt": "A String", # Optional. Code excerpt where the source was detected along with surrounding code.
"lineNumber": 42, # Required. Line number (1-based).
"path": "A String", # Required. Path of the file.
"startLineNumber": 42, # Optional. Start line number of the code excerpt (1-based).
},
"dataType": "A String", # Required. Data type.
"falsePositive": True or False, # Optional. Whether the finding was marked as a false positive.
},
],
},
"cliVersion": "A String", # Required. CLI version.
"localScanPath": "A String", # Required. Local scan path.
"scmMetadata": { # SCM metadata. # Required. SCM metadata.
"branch": "A String", # Required. Branch name.
"pullRequest": { # Pull request info. # Optional. Contains info about the associated pull request. This is only populated for pull request scans.
"baseBranch": "A String", # Required. For PR analysis, we compare against the most recent scan of the base branch to highlight new issues.
"prNumber": "A String", # Required. This can be supplied by the user or parsed automatically from predefined CI environment variables.
},
"remoteUri": "A String", # Required. Git remote URL.
"revisionId": "A String", # Required. Revision ID, e.g. Git commit hash.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
get(name, x__xgafv=None)
Gets a repo scan. By default, only the name and results_uri fields are returned. You can include other fields by listing them in the `fields` URL query parameter. For example, `?fields=name,sources` will return the name and sources fields.
Args:
name: string, Required. Resource name of the repo scan. Example: `accounts/123/repos/456/scans/789` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Repo scan.
"cliVersion": "A String", # CLI version.
"localScanPath": "A String", # Local scan path.
"name": "A String", # Identifier. Resource name of the scan.
"resultsUri": "A String", # A URL to view results.
"scmMetadata": { # SCM metadata. # SCM metadata.
"branch": "A String", # Required. Branch name.
"pullRequest": { # Pull request info. # Optional. Contains info about the associated pull request. This is only populated for pull request scans.
"baseBranch": "A String", # Required. For PR analysis, we compare against the most recent scan of the base branch to highlight new issues.
"prNumber": "A String", # Required. This can be supplied by the user or parsed automatically from predefined CI environment variables.
},
"remoteUri": "A String", # Required. Git remote URL.
"revisionId": "A String", # Required. Revision ID, e.g. Git commit hash.
},
"sources": [ # Data sources detected.
{ # Represents a data source finding.
"codeAttribution": { # Source code attribution. # Optional. Source code attribution for the finding.
"codeExcerpt": "A String", # Optional. Code excerpt where the source was detected along with surrounding code.
"lineNumber": 42, # Required. Line number (1-based).
"path": "A String", # Required. Path of the file.
"startLineNumber": 42, # Optional. Start line number of the code excerpt (1-based).
},
"dataType": "A String", # Required. Data type.
"falsePositive": True or False, # Optional. Whether the finding was marked as a false positive.
},
],
}
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists repo scans for the specified repo.
Args:
parent: string, Required. Resource name of the repo. Example: `accounts/123/repos/456` (required)
filter: string, Optional. An [AIP-160](https://google.aip.dev/160) filter string to filter repo scans. Example: `scmMetadata.branch = main`
pageSize: integer, Optional. The maximum number of repo scans to return. If unspecified, at most 10 repo scans will be returned. The maximum value is 50; values above 50 will be coerced to 50.
pageToken: string, Optional. A page token received from a previous `ListRepoScans` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRepoScans` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response message for RepoScanService.ListRepoScans.
"nextPageToken": "A String", # A token which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"repoScans": [ # The repo scans for the specified app.
{ # Repo scan.
"cliVersion": "A String", # CLI version.
"localScanPath": "A String", # Local scan path.
"name": "A String", # Identifier. Resource name of the scan.
"resultsUri": "A String", # A URL to view results.
"scmMetadata": { # SCM metadata. # SCM metadata.
"branch": "A String", # Required. Branch name.
"pullRequest": { # Pull request info. # Optional. Contains info about the associated pull request. This is only populated for pull request scans.
"baseBranch": "A String", # Required. For PR analysis, we compare against the most recent scan of the base branch to highlight new issues.
"prNumber": "A String", # Required. This can be supplied by the user or parsed automatically from predefined CI environment variables.
},
"remoteUri": "A String", # Required. Git remote URL.
"revisionId": "A String", # Required. Revision ID, e.g. Git commit hash.
},
"sources": [ # Data sources detected.
{ # Represents a data source finding.
"codeAttribution": { # Source code attribution. # Optional. Source code attribution for the finding.
"codeExcerpt": "A String", # Optional. Code excerpt where the source was detected along with surrounding code.
"lineNumber": 42, # Required. Line number (1-based).
"path": "A String", # Required. Path of the file.
"startLineNumber": 42, # Optional. Start line number of the code excerpt (1-based).
},
"dataType": "A String", # Required. Data type.
"falsePositive": True or False, # Optional. Whether the finding was marked as a false positive.
},
],
},
],
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.