Google Git
Sign in
code / google-api-go-client / 47bfb779e66a0dd56fb1fe17468c5c0e91c4db06 / . / containeranalysis / v1alpha1 / containeranalysis-api.json
blob: 28af2dfe43377f7f6f85c58c3aa69ecdc89cc622 [file] [log] [blame]
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"basePath": "",
"baseUrl": "https://containeranalysis.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Container Analysis",
"description": "An implementation of the Grafeas API, which stores, and enables querying and retrieval of critical metadata about all of your software artifacts.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/container-analysis/api/reference/rest/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "containeranalysis:v1alpha1",
"kind": "discovery#restDescription",
"name": "containeranalysis",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"projects": {
"resources": {
"notes": {
"methods": {
"create": {
"description": "Creates a new `Note`.",
"flatPath": "v1alpha1/projects/{projectsId}/notes",
"httpMethod": "POST",
"id": "containeranalysis.projects.notes.create",
"parameterOrder": [
"parent"
],
"parameters": {
"name": {
"description": "The name of the project.\nShould be of the form \"providers/{provider_id}\".\n@Deprecated",
"location": "query",
"type": "string"
},
"noteId": {
"description": "The ID to use for this note.",
"location": "query",
"type": "string"
},
"parent": {
"description": "This field contains the project Id for example:\n\"projects/{project_id}",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha1/{+parent}/notes",
"request": {
"$ref": "Note"
},
"response": {
"$ref": "Note"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes the given `Note` from the system.",
"flatPath": "v1alpha1/projects/{projectsId}/notes/{notesId}",
"httpMethod": "DELETE",
"id": "containeranalysis.projects.notes.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the note in the form of\n\"providers/{provider_id}/notes/{NOTE_ID}\"",
"location": "path",
"pattern": "^projects/[^/]+/notes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Returns the requested `Note`.",
"flatPath": "v1alpha1/projects/{projectsId}/notes/{notesId}",
"httpMethod": "GET",
"id": "containeranalysis.projects.notes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the note in the form of\n\"providers/{provider_id}/notes/{NOTE_ID}\"",
"location": "path",
"pattern": "^projects/[^/]+/notes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha1/{+name}",
"response": {
"$ref": "Note"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a note or an `Occurrence` resource.\nRequires `containeranalysis.notes.setIamPolicy` or\n`containeranalysis.occurrences.setIamPolicy` permission if the resource is\na note or occurrence, respectively.\nAttempting to call this method on a resource without the required\npermission will result in a `PERMISSION_DENIED` error. Attempting to call\nthis method on a non-existent resource will result in a `NOT_FOUND` error\nif the user has list permission on the project, or a `PERMISSION_DENIED`\nerror otherwise. The resource takes the following formats:\n`projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for occurrences and\nprojects/{PROJECT_ID}/notes/{NOTE_ID} for notes",
"flatPath": "v1alpha1/projects/{projectsId}/notes/{notesId}:getIamPolicy",
"httpMethod": "POST",
"id": "containeranalysis.projects.notes.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/notes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha1/{+resource}:getIamPolicy",
"request": {
"$ref": "GetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all `Notes` for a given project.",
"flatPath": "v1alpha1/projects/{projectsId}/notes",
"httpMethod": "GET",
"id": "containeranalysis.projects.notes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "The filter expression.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name field will contain the project Id for example:\n\"providers/{provider_id}\n@Deprecated",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Number of notes to return in the list.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Token to provide to skip to a particular spot in the list.",
"location": "query",
"type": "string"
},
"parent": {
"description": "This field contains the project Id for example: \"projects/{PROJECT_ID}\".",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha1/{+parent}/notes",
"response": {
"$ref": "ListNotesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates an existing `Note`.",
"flatPath": "v1alpha1/projects/{projectsId}/notes/{notesId}",
"httpMethod": "PATCH",
"id": "containeranalysis.projects.notes.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the note.\nShould be of the form \"projects/{provider_id}/notes/{note_id}\".",
"location": "path",
"pattern": "^projects/[^/]+/notes/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "The fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1alpha1/{+name}",
"request": {
"$ref": "Note"
},
"response": {
"$ref": "Note"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified `Note` or `Occurrence`.\nRequires `containeranalysis.notes.setIamPolicy` or\n`containeranalysis.occurrences.setIamPolicy` permission if the resource is\na `Note` or an `Occurrence`, respectively.\nAttempting to call this method without these permissions will result in a `\n`PERMISSION_DENIED` error.\nAttempting to call this method on a non-existent resource will result in a\n`NOT_FOUND` error if the user has `containeranalysis.notes.list` permission\non a `Note` or `containeranalysis.occurrences.list` on an `Occurrence`, or\na `PERMISSION_DENIED` error otherwise. The resource takes the following\nformats: `projects/{projectid}/occurrences/{occurrenceid}` for occurrences\nand projects/{projectid}/notes/{noteid} for notes",
"flatPath": "v1alpha1/projects/{projectsId}/notes/{notesId}:setIamPolicy",
"httpMethod": "POST",
"id": "containeranalysis.projects.notes.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/notes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha1/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"testIamPermissions": {
"description": "Returns the permissions that a caller has on the specified note or\noccurrence resource. Requires list permission on the project (for example,\n\"storage.objects.list\" on the containing bucket for testing permission of\nan object). Attempting to call this method on a non-existent resource will\nresult in a `NOT_FOUND` error if the user has list permission on the\nproject, or a `PERMISSION_DENIED` error otherwise. The resource takes the\nfollowing formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for\n`Occurrences` and `projects/{PROJECT_ID}/notes/{NOTE_ID}` for `Notes`",
"flatPath": "v1alpha1/projects/{projectsId}/notes/{notesId}:testIamPermissions",
"httpMethod": "POST",
"id": "containeranalysis.projects.notes.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/notes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"occurrences": {
"methods": {
"list": {
"description": "Lists `Occurrences` referencing the specified `Note`. Use this method to\nget all occurrences referencing your `Note` across all your customer\nprojects.",
"flatPath": "v1alpha1/projects/{projectsId}/notes/{notesId}/occurrences",
"httpMethod": "GET",
"id": "containeranalysis.projects.notes.occurrences.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The filter expression.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name field will contain the note name for example:\n \"provider/{provider_id}/notes/{note_id}\"",
"location": "path",
"pattern": "^projects/[^/]+/notes/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "Number of notes to return in the list.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Token to provide to skip to a particular spot in the list.",
"location": "query",
"type": "string"
}
},
"path": "v1alpha1/{+name}/occurrences",
"response": {
"$ref": "ListNoteOccurrencesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"occurrences": {
"methods": {
"create": {
"description": "Creates a new `Occurrence`. Use this method to create `Occurrences`\nfor a resource.",
"flatPath": "v1alpha1/projects/{projectsId}/occurrences",
"httpMethod": "POST",
"id": "containeranalysis.projects.occurrences.create",
"parameterOrder": [
"parent"
],
"parameters": {
"name": {
"description": "The name of the project. Should be of the form \"projects/{project_id}\".\n@Deprecated",
"location": "query",
"type": "string"
},
"parent": {
"description": "This field contains the project Id for example: \"projects/{project_id}\"",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha1/{+parent}/occurrences",
"request": {
"$ref": "Occurrence"
},
"response": {
"$ref": "Occurrence"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes the given `Occurrence` from the system. Use this when\nan `Occurrence` is no longer applicable for the given resource.",
"flatPath": "v1alpha1/projects/{projectsId}/occurrences/{occurrencesId}",
"httpMethod": "DELETE",
"id": "containeranalysis.projects.occurrences.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the occurrence in the form of\n\"projects/{project_id}/occurrences/{OCCURRENCE_ID}\"",
"location": "path",
"pattern": "^projects/[^/]+/occurrences/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Returns the requested `Occurrence`.",
"flatPath": "v1alpha1/projects/{projectsId}/occurrences/{occurrencesId}",
"httpMethod": "GET",
"id": "containeranalysis.projects.occurrences.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the occurrence of the form\n\"projects/{project_id}/occurrences/{OCCURRENCE_ID}\"",
"location": "path",
"pattern": "^projects/[^/]+/occurrences/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha1/{+name}",
"response": {
"$ref": "Occurrence"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a note or an `Occurrence` resource.\nRequires `containeranalysis.notes.setIamPolicy` or\n`containeranalysis.occurrences.setIamPolicy` permission if the resource is\na note or occurrence, respectively.\nAttempting to call this method on a resource without the required\npermission will result in a `PERMISSION_DENIED` error. Attempting to call\nthis method on a non-existent resource will result in a `NOT_FOUND` error\nif the user has list permission on the project, or a `PERMISSION_DENIED`\nerror otherwise. The resource takes the following formats:\n`projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for occurrences and\nprojects/{PROJECT_ID}/notes/{NOTE_ID} for notes",
"flatPath": "v1alpha1/projects/{projectsId}/occurrences/{occurrencesId}:getIamPolicy",
"httpMethod": "POST",
"id": "containeranalysis.projects.occurrences.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/occurrences/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha1/{+resource}:getIamPolicy",
"request": {
"$ref": "GetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getNotes": {
"description": "Gets the `Note` attached to the given `Occurrence`.",
"flatPath": "v1alpha1/projects/{projectsId}/occurrences/{occurrencesId}/notes",
"httpMethod": "GET",
"id": "containeranalysis.projects.occurrences.getNotes",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the occurrence in the form\n\"projects/{project_id}/occurrences/{OCCURRENCE_ID}\"",
"location": "path",
"pattern": "^projects/[^/]+/occurrences/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha1/{+name}/notes",
"response": {
"$ref": "Note"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getVulnerabilitySummary": {
"description": "Gets a summary of the number and severity of occurrences.",
"flatPath": "v1alpha1/projects/{projectsId}/occurrences:vulnerabilitySummary",
"httpMethod": "GET",
"id": "containeranalysis.projects.occurrences.getVulnerabilitySummary",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "The filter expression.",
"location": "query",
"type": "string"
},
"parent": {
"description": "This contains the project Id for example: projects/{project_id}",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha1/{+parent}/occurrences:vulnerabilitySummary",
"response": {
"$ref": "GetVulnzOccurrencesSummaryResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists active `Occurrences` for a given project matching the filters.",
"flatPath": "v1alpha1/projects/{projectsId}/occurrences",
"httpMethod": "GET",
"id": "containeranalysis.projects.occurrences.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "The filter expression.",
"location": "query",
"type": "string"
},
"kind": {
"description": "The kind of occurrences to filter on.",
"enum": [
"KIND_UNSPECIFIED",
"PACKAGE_VULNERABILITY",
"BUILD_DETAILS",
"IMAGE_BASIS",
"PACKAGE_MANAGER",
"DEPLOYABLE",
"DISCOVERY",
"ATTESTATION_AUTHORITY",
"UPGRADE"
],
"location": "query",
"type": "string"
},
"name": {
"description": "The name field contains the project Id. For example:\n\"projects/{project_id}\n@Deprecated",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Number of occurrences to return in the list.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Token to provide to skip to a particular spot in the list.",
"location": "query",
"type": "string"
},
"parent": {
"description": "This contains the project Id for example: projects/{project_id}.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha1/{+parent}/occurrences",
"response": {
"$ref": "ListOccurrencesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates an existing occurrence.",
"flatPath": "v1alpha1/projects/{projectsId}/occurrences/{occurrencesId}",
"httpMethod": "PATCH",
"id": "containeranalysis.projects.occurrences.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the occurrence.\nShould be of the form \"projects/{project_id}/occurrences/{OCCURRENCE_ID}\".",
"location": "path",
"pattern": "^projects/[^/]+/occurrences/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "The fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1alpha1/{+name}",
"request": {
"$ref": "Occurrence"
},
"response": {
"$ref": "Occurrence"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified `Note` or `Occurrence`.\nRequires `containeranalysis.notes.setIamPolicy` or\n`containeranalysis.occurrences.setIamPolicy` permission if the resource is\na `Note` or an `Occurrence`, respectively.\nAttempting to call this method without these permissions will result in a `\n`PERMISSION_DENIED` error.\nAttempting to call this method on a non-existent resource will result in a\n`NOT_FOUND` error if the user has `containeranalysis.notes.list` permission\non a `Note` or `containeranalysis.occurrences.list` on an `Occurrence`, or\na `PERMISSION_DENIED` error otherwise. The resource takes the following\nformats: `projects/{projectid}/occurrences/{occurrenceid}` for occurrences\nand projects/{projectid}/notes/{noteid} for notes",
"flatPath": "v1alpha1/projects/{projectsId}/occurrences/{occurrencesId}:setIamPolicy",
"httpMethod": "POST",
"id": "containeranalysis.projects.occurrences.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/occurrences/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha1/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"testIamPermissions": {
"description": "Returns the permissions that a caller has on the specified note or\noccurrence resource. Requires list permission on the project (for example,\n\"storage.objects.list\" on the containing bucket for testing permission of\nan object). Attempting to call this method on a non-existent resource will\nresult in a `NOT_FOUND` error if the user has list permission on the\nproject, or a `PERMISSION_DENIED` error otherwise. The resource takes the\nfollowing formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for\n`Occurrences` and `projects/{PROJECT_ID}/notes/{NOTE_ID}` for `Notes`",
"flatPath": "v1alpha1/projects/{projectsId}/occurrences/{occurrencesId}:testIamPermissions",
"httpMethod": "POST",
"id": "containeranalysis.projects.occurrences.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/occurrences/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"operations": {
"methods": {
"create": {
"description": "Creates a new `Operation`.",
"flatPath": "v1alpha1/projects/{projectsId}/operations",
"httpMethod": "POST",
"id": "containeranalysis.projects.operations.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "The project Id that this operation should be created under.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha1/{+parent}/operations",
"request": {
"$ref": "CreateOperationRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates an existing operation returns an error if operation\n does not exist. The only valid operations are to update mark the done bit\nchange the result.",
"flatPath": "v1alpha1/projects/{projectsId}/operations/{operationsId}",
"httpMethod": "PATCH",
"id": "containeranalysis.projects.operations.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the Operation.\nShould be of the form \"projects/{provider_id}/operations/{operation_id}\".",
"location": "path",
"pattern": "^projects/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha1/{+name}",
"request": {
"$ref": "UpdateOperationRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"scanConfigs": {
"methods": {
"get": {
"description": "Gets a specific scan configuration for a project.",
"flatPath": "v1alpha1/projects/{projectsId}/scanConfigs/{scanConfigsId}",
"httpMethod": "GET",
"id": "containeranalysis.projects.scanConfigs.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the ScanConfig in the form\nprojects/{project_id}/scanConfigs/{scan_config_id}",
"location": "path",
"pattern": "^projects/[^/]+/scanConfigs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha1/{+name}",
"response": {
"$ref": "ScanConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists scan configurations for a project.",
"flatPath": "v1alpha1/projects/{projectsId}/scanConfigs",
"httpMethod": "GET",
"id": "containeranalysis.projects.scanConfigs.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "The filter expression.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "The number of items to return.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The page token to use for the next request.",
"location": "query",
"type": "string"
},
"parent": {
"description": "This containers the project Id i.e.: projects/{project_id}",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha1/{+parent}/scanConfigs",
"response": {
"$ref": "ListScanConfigsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates the scan configuration to a new value.",
"flatPath": "v1alpha1/projects/{projectsId}/scanConfigs/{scanConfigsId}",
"httpMethod": "PATCH",
"id": "containeranalysis.projects.scanConfigs.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The scan config to update of the form\nprojects/{project_id}/scanConfigs/{scan_config_id}.",
"location": "path",
"pattern": "^projects/[^/]+/scanConfigs/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "The fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1alpha1/{+name}",
"request": {
"$ref": "ScanConfig"
},
"response": {
"$ref": "ScanConfig"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"providers": {
"resources": {
"notes": {
"methods": {
"create": {
"description": "Creates a new `Note`.",
"flatPath": "v1alpha1/providers/{providersId}/notes",
"httpMethod": "POST",
"id": "containeranalysis.providers.notes.create",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the project.\nShould be of the form \"providers/{provider_id}\".\n@Deprecated",
"location": "path",
"pattern": "^providers/[^/]+$",
"required": true,
"type": "string"
},
"noteId": {
"description": "The ID to use for this note.",
"location": "query",
"type": "string"
},
"parent": {
"description": "This field contains the project Id for example:\n\"projects/{project_id}",
"location": "query",
"type": "string"
}
},
"path": "v1alpha1/{+name}/notes",
"request": {
"$ref": "Note"
},
"response": {
"$ref": "Note"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes the given `Note` from the system.",
"flatPath": "v1alpha1/providers/{providersId}/notes/{notesId}",
"httpMethod": "DELETE",
"id": "containeranalysis.providers.notes.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the note in the form of\n\"providers/{provider_id}/notes/{NOTE_ID}\"",
"location": "path",
"pattern": "^providers/[^/]+/notes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Returns the requested `Note`.",
"flatPath": "v1alpha1/providers/{providersId}/notes/{notesId}",
"httpMethod": "GET",
"id": "containeranalysis.providers.notes.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the note in the form of\n\"providers/{provider_id}/notes/{NOTE_ID}\"",
"location": "path",
"pattern": "^providers/[^/]+/notes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha1/{+name}",
"response": {
"$ref": "Note"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a note or an `Occurrence` resource.\nRequires `containeranalysis.notes.setIamPolicy` or\n`containeranalysis.occurrences.setIamPolicy` permission if the resource is\na note or occurrence, respectively.\nAttempting to call this method on a resource without the required\npermission will result in a `PERMISSION_DENIED` error. Attempting to call\nthis method on a non-existent resource will result in a `NOT_FOUND` error\nif the user has list permission on the project, or a `PERMISSION_DENIED`\nerror otherwise. The resource takes the following formats:\n`projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for occurrences and\nprojects/{PROJECT_ID}/notes/{NOTE_ID} for notes",
"flatPath": "v1alpha1/providers/{providersId}/notes/{notesId}:getIamPolicy",
"httpMethod": "POST",
"id": "containeranalysis.providers.notes.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^providers/[^/]+/notes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha1/{+resource}:getIamPolicy",
"request": {
"$ref": "GetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all `Notes` for a given project.",
"flatPath": "v1alpha1/providers/{providersId}/notes",
"httpMethod": "GET",
"id": "containeranalysis.providers.notes.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The filter expression.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name field will contain the project Id for example:\n\"providers/{provider_id}\n@Deprecated",
"location": "path",
"pattern": "^providers/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "Number of notes to return in the list.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Token to provide to skip to a particular spot in the list.",
"location": "query",
"type": "string"
},
"parent": {
"description": "This field contains the project Id for example: \"projects/{PROJECT_ID}\".",
"location": "query",
"type": "string"
}
},
"path": "v1alpha1/{+name}/notes",
"response": {
"$ref": "ListNotesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates an existing `Note`.",
"flatPath": "v1alpha1/providers/{providersId}/notes/{notesId}",
"httpMethod": "PATCH",
"id": "containeranalysis.providers.notes.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the note.\nShould be of the form \"projects/{provider_id}/notes/{note_id}\".",
"location": "path",
"pattern": "^providers/[^/]+/notes/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "The fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1alpha1/{+name}",
"request": {
"$ref": "Note"
},
"response": {
"$ref": "Note"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified `Note` or `Occurrence`.\nRequires `containeranalysis.notes.setIamPolicy` or\n`containeranalysis.occurrences.setIamPolicy` permission if the resource is\na `Note` or an `Occurrence`, respectively.\nAttempting to call this method without these permissions will result in a `\n`PERMISSION_DENIED` error.\nAttempting to call this method on a non-existent resource will result in a\n`NOT_FOUND` error if the user has `containeranalysis.notes.list` permission\non a `Note` or `containeranalysis.occurrences.list` on an `Occurrence`, or\na `PERMISSION_DENIED` error otherwise. The resource takes the following\nformats: `projects/{projectid}/occurrences/{occurrenceid}` for occurrences\nand projects/{projectid}/notes/{noteid} for notes",
"flatPath": "v1alpha1/providers/{providersId}/notes/{notesId}:setIamPolicy",
"httpMethod": "POST",
"id": "containeranalysis.providers.notes.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^providers/[^/]+/notes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha1/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"testIamPermissions": {
"description": "Returns the permissions that a caller has on the specified note or\noccurrence resource. Requires list permission on the project (for example,\n\"storage.objects.list\" on the containing bucket for testing permission of\nan object). Attempting to call this method on a non-existent resource will\nresult in a `NOT_FOUND` error if the user has list permission on the\nproject, or a `PERMISSION_DENIED` error otherwise. The resource takes the\nfollowing formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for\n`Occurrences` and `projects/{PROJECT_ID}/notes/{NOTE_ID}` for `Notes`",
"flatPath": "v1alpha1/providers/{providersId}/notes/{notesId}:testIamPermissions",
"httpMethod": "POST",
"id": "containeranalysis.providers.notes.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^providers/[^/]+/notes/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"occurrences": {
"methods": {
"list": {
"description": "Lists `Occurrences` referencing the specified `Note`. Use this method to\nget all occurrences referencing your `Note` across all your customer\nprojects.",
"flatPath": "v1alpha1/providers/{providersId}/notes/{notesId}/occurrences",
"httpMethod": "GET",
"id": "containeranalysis.providers.notes.occurrences.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The filter expression.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name field will contain the note name for example:\n \"provider/{provider_id}/notes/{note_id}\"",
"location": "path",
"pattern": "^providers/[^/]+/notes/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "Number of notes to return in the list.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Token to provide to skip to a particular spot in the list.",
"location": "query",
"type": "string"
}
},
"path": "v1alpha1/{+name}/occurrences",
"response": {
"$ref": "ListNoteOccurrencesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
}
},
"revision": "20191118",
"rootUrl": "https://containeranalysis.googleapis.com/",
"schemas": {
"Artifact": {
"description": "Artifact describes a build product.",
"id": "Artifact",
"properties": {
"checksum": {
"description": "Hash or checksum value of a binary, or Docker Registry 2.0 digest of a\ncontainer.",
"type": "string"
},
"id": {
"description": "Artifact ID, if any; for container images, this will be a URL by digest\nlike gcr.io/projectID/imagename@sha256:123456",
"type": "string"
},
"name": {
"description": "Name of the artifact. This may be the path to a binary or jar file, or in\nthe case of a container build, the name used to push the container image to\nGoogle Container Registry, as presented to `docker push`.\n\nThis field is deprecated in favor of the plural `names` field; it continues\nto exist here to allow existing BuildProvenance serialized to json in\ngoogle.devtools.containeranalysis.v1alpha1.BuildDetails.provenance_bytes to\ndeserialize back into proto.",
"type": "string"
},
"names": {
"description": "Related artifact names. This may be the path to a binary or jar file, or in\nthe case of a container build, the name used to push the container image to\nGoogle Container Registry, as presented to `docker push`. Note that a\nsingle Artifact ID can have multiple names, for example if two tags are\napplied to one image.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Attestation": {
"description": "Occurrence that represents a single \"attestation\". The authenticity of an\nAttestation can be verified using the attached signature. If the verifier\ntrusts the public key of the signer, then verifying the signature is\nsufficient to establish trust. In this circumstance, the\nAttestationAuthority to which this Attestation is attached is primarily\nuseful for look-up (how to find this Attestation if you already know the\nAuthority and artifact to be verified) and intent (which authority was this\nattestation intended to sign for).",
"id": "Attestation",
"properties": {
"pgpSignedAttestation": {
"$ref": "PgpSignedAttestation"
}
},
"type": "object"
},
"AttestationAuthority": {
"description": "Note kind that represents a logical attestation \"role\" or \"authority\". For\nexample, an organization might have one `AttestationAuthority` for \"QA\" and\none for \"build\". This Note is intended to act strictly as a grouping\nmechanism for the attached Occurrences (Attestations). This grouping\nmechanism also provides a security boundary, since IAM ACLs gate the ability\nfor a principle to attach an Occurrence to a given Note. It also provides a\nsingle point of lookup to find all attached Attestation Occurrences, even if\nthey don't all live in the same project.",
"id": "AttestationAuthority",
"properties": {
"hint": {
"$ref": "AttestationAuthorityHint"
}
},
"type": "object"
},
"AttestationAuthorityHint": {
"description": "This submessage provides human-readable hints about the purpose of the\nAttestationAuthority. Because the name of a Note acts as its resource\nreference, it is important to disambiguate the canonical name of the Note\n(which might be a UUID for security purposes) from \"readable\" names more\nsuitable for debug output. Note that these hints should NOT be used to\nlook up AttestationAuthorities in security sensitive contexts, such as when\nlooking up Attestations to verify.",
"id": "AttestationAuthorityHint",
"properties": {
"humanReadableName": {
"description": "The human readable name of this Attestation Authority, for example \"qa\".",
"type": "string"
}
},
"type": "object"
},
"Basis": {
"description": "Basis describes the base image portion (Note) of the DockerImage\nrelationship. Linked occurrences are derived from this or an\nequivalent image via:\n FROM \u003cBasis.resource_url\u003e\nOr an equivalent reference, e.g. a tag of the resource_url.",
"id": "Basis",
"properties": {
"fingerprint": {
"$ref": "Fingerprint",
"description": "The fingerprint of the base image."
},
"resourceUrl": {
"description": "The resource_url for the resource representing the basis of\nassociated occurrence images.",
"type": "string"
}
},
"type": "object"
},
"Binding": {
"description": "Associates `members` with a `role`.",
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding.\nNOTE: An unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
"type": "object"
},
"BuildDetails": {
"description": "Message encapsulating build provenance details.",
"id": "BuildDetails",
"properties": {
"provenance": {
"$ref": "BuildProvenance",
"description": "The actual provenance"
},
"provenanceBytes": {
"description": "Serialized JSON representation of the provenance, used in generating the\n`BuildSignature` in the corresponding Result. After verifying the\nsignature, `provenance_bytes` can be unmarshalled and compared to the\nprovenance to confirm that it is unchanged. A base64-encoded string\nrepresentation of the provenance bytes is used for the signature in order\nto interoperate with openssl which expects this format for signature\nverification.\n\nThe serialized form is captured both to avoid ambiguity in how the\nprovenance is marshalled to json as well to prevent incompatibilities with\nfuture changes.",
"type": "string"
}
},
"type": "object"
},
"BuildProvenance": {
"description": "Provenance of a build. Contains all information needed to verify the full\ndetails about the build from source to completion.",
"id": "BuildProvenance",
"properties": {
"buildOptions": {
"additionalProperties": {
"type": "string"
},
"description": "Special options applied to this build. This is a catch-all field where\nbuild providers can enter any desired additional details.",
"type": "object"
},
"builderVersion": {
"description": "Version string of the builder at the time this build was executed.",
"type": "string"
},
"builtArtifacts": {
"description": "Output of the build.",
"items": {
"$ref": "Artifact"
},
"type": "array"
},
"commands": {
"description": "Commands requested by the build.",
"items": {
"$ref": "Command"
},
"type": "array"
},
"createTime": {
"description": "Time at which the build was created.",
"format": "google-datetime",
"type": "string"
},
"creator": {
"description": "E-mail address of the user who initiated this build. Note that this was the\nuser's e-mail address at the time the build was initiated; this address may\nnot represent the same end-user for all time.",
"type": "string"
},
"finishTime": {
"description": "Time at which execution of the build was finished.",
"format": "google-datetime",
"type": "string"
},
"id": {
"description": "Unique identifier of the build.",
"type": "string"
},
"logsBucket": {
"description": "Google Cloud Storage bucket where logs were written.",
"type": "string"
},
"projectId": {
"description": "ID of the project.",
"type": "string"
},
"sourceProvenance": {
"$ref": "Source",
"description": "Details of the Source input to the build."
},
"startTime": {
"description": "Time at which execution of the build was started.",
"format": "google-datetime",
"type": "string"
},
"triggerId": {
"description": "Trigger identifier if the build was triggered automatically; empty if not.",
"type": "string"
}
},
"type": "object"
},
"BuildSignature": {
"description": "Message encapsulating the signature of the verified build.",
"id": "BuildSignature",
"properties": {
"keyId": {
"description": "An Id for the key used to sign. This could be either an Id for the key\nstored in `public_key` (such as the Id or fingerprint for a PGP key, or the\nCN for a cert), or a reference to an external key (such as a reference to a\nkey in Cloud Key Management Service).",
"type": "string"
},
"keyType": {
"description": "The type of the key, either stored in `public_key` or referenced in\n`key_id`",
"enum": [
"KEY_TYPE_UNSPECIFIED",
"PGP_ASCII_ARMORED",
"PKIX_PEM"
],
"enumDescriptions": [
"`KeyType` is not set.",
"`PGP ASCII Armored` public key.",
"`PKIX PEM` public key."
],
"type": "string"
},
"publicKey": {
"description": "Public key of the builder which can be used to verify that the related\nfindings are valid and unchanged. If `key_type` is empty, this defaults\nto PEM encoded public keys.\n\nThis field may be empty if `key_id` references an external key.\n\nFor Cloud Build based signatures, this is a PEM encoded public\nkey. To verify the Cloud Build signature, place the contents of\nthis field into a file (public.pem). The signature field is base64-decoded\ninto its binary representation in signature.bin, and the provenance bytes\nfrom `BuildDetails` are base64-decoded into a binary representation in\nsigned.bin. OpenSSL can then verify the signature:\n`openssl sha256 -verify public.pem -signature signature.bin signed.bin`",
"type": "string"
},
"signature": {
"description": "Signature of the related `BuildProvenance`, encoded in a base64 string.",
"type": "string"
}
},
"type": "object"
},
"BuildType": {
"description": "Note holding the version of the provider's builder and the signature of\nthe provenance message in linked BuildDetails.",
"id": "BuildType",
"properties": {
"builderVersion": {
"description": "Version of the builder which produced this Note.",
"type": "string"
},
"signature": {
"$ref": "BuildSignature",
"description": "Signature of the build in Occurrences pointing to the Note containing this\n`BuilderDetails`."
}
},
"type": "object"
},
"Command": {
"description": "Command describes a step performed as part of the build pipeline.",
"id": "Command",
"properties": {
"args": {
"description": "Command-line arguments used when executing this Command.",
"items": {
"type": "string"
},
"type": "array"
},
"dir": {
"description": "Working directory (relative to project source root) used when running\nthis Command.",
"type": "string"
},
"env": {
"description": "Environment variables set before running this Command.",
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"description": "Optional unique identifier for this Command, used in wait_for to reference\nthis Command as a dependency.",
"type": "string"
},
"name": {
"description": "Name of the command, as presented on the command line, or if the command is\npackaged as a Docker container, as presented to `docker pull`.",
"type": "string"
},
"waitFor": {
"description": "The ID(s) of the Command(s) that this Command depends on.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"CreateOperationRequest": {
"description": "Request for creating an operation",
"id": "CreateOperationRequest",
"properties": {
"operation": {
"$ref": "Operation",
"description": "The operation to create."
},
"operationId": {
"description": "The ID to use for this operation.",
"type": "string"
}
},
"type": "object"
},
"Deployable": {
"description": "An artifact that can be deployed in some runtime.",
"id": "Deployable",
"properties": {
"resourceUri": {
"description": "Resource URI for the artifact being deployed.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Deployment": {
"description": "The period during which some deployable was active in a runtime.",
"id": "Deployment",
"properties": {
"address": {
"description": "Address of the runtime element hosting this deployment.",
"type": "string"
},
"config": {
"description": "Configuration used to create this deployment.",
"type": "string"
},
"deployTime": {
"description": "Beginning of the lifetime of this deployment.",
"format": "google-datetime",
"type": "string"
},
"platform": {
"description": "Platform hosting this deployment.",
"enum": [
"PLATFORM_UNSPECIFIED",
"GKE",
"FLEX",
"CUSTOM"
],
"enumDescriptions": [
"Unknown",
"Google Container Engine",
"Google App Engine: Flexible Environment",
"Custom user-defined platform"
],
"type": "string"
},
"resourceUri": {
"description": "Output only. Resource URI for the artifact being deployed taken from the\ndeployable field with the same name.",
"items": {
"type": "string"
},
"type": "array"
},
"undeployTime": {
"description": "End of the lifetime of this deployment.",
"format": "google-datetime",
"type": "string"
},
"userEmail": {
"description": "Identity of the user that triggered this deployment.",
"type": "string"
}
},
"type": "object"
},
"Derived": {
"description": "Derived describes the derived image portion (Occurrence) of the\nDockerImage relationship. This image would be produced from a Dockerfile\nwith FROM \u003cDockerImage.Basis in attached Note\u003e.",
"id": "Derived",
"properties": {
"baseResourceUrl": {
"description": "Output only. This contains the base image URL for the derived image\noccurrence.",
"type": "string"
},
"distance": {
"description": "Output only. The number of layers by which this image differs from the\nassociated image basis.",
"format": "uint32",
"type": "integer"
},
"fingerprint": {
"$ref": "Fingerprint",
"description": "The fingerprint of the derived image."
},
"layerInfo": {
"description": "This contains layer-specific metadata, if populated it has length\n\"distance\" and is ordered with [distance] being the layer immediately\nfollowing the base image and [1] being the final layer.",
"items": {
"$ref": "Layer"
},
"type": "array"
}
},
"type": "object"
},
"Detail": {
"description": "Identifies all occurrences of this vulnerability in the package for a\nspecific distro/location\nFor example: glibc in cpe:/o:debian:debian_linux:8 for versions 2.1 - 2.2",
"id": "Detail",
"properties": {
"cpeUri": {
"description": "The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in\nwhich the vulnerability manifests. Examples include distro or storage\nlocation for vulnerable jar.\nThis field can be used as a filter in list requests.",
"type": "string"
},
"description": {
"description": "A vendor-specific description of this note.",
"type": "string"
},
"fixedLocation": {
"$ref": "VulnerabilityLocation",
"description": "The fix for this specific package version."
},
"isObsolete": {
"description": "Whether this Detail is obsolete. Occurrences are expected not to point to\nobsolete details.",
"type": "boolean"
},
"maxAffectedVersion": {
"$ref": "Version",
"description": "The max version of the package in which the vulnerability exists."
},
"minAffectedVersion": {
"$ref": "Version",
"description": "The min version of the package in which the vulnerability exists."
},
"package": {
"description": "The name of the package where the vulnerability was found.\nThis field can be used as a filter in list requests.",
"type": "string"
},
"packageType": {
"description": "The type of package; whether native or non native(ruby gems,\nnode.js packages etc)",
"type": "string"
},
"severityName": {
"description": "The severity (eg: distro assigned severity) for this vulnerability.",
"type": "string"
}
},
"type": "object"
},
"Discovered": {
"description": "Provides information about the scan status of a discovered resource.",
"id": "Discovered",
"properties": {
"analysisStatus": {
"description": "The status of discovery for the resource.",
"enum": [
"ANALYSIS_STATUS_UNSPECIFIED",
"PENDING",
"SCANNING",
"FINISHED_SUCCESS",
"FINISHED_FAILED",
"FINISHED_UNSUPPORTED"
],
"enumDescriptions": [
"Unknown",
"Resource is known but no action has been taken yet.",
"Resource is being analyzed.",
"Analysis has finished successfully.",
"Analysis has finished unsuccessfully, the analysis itself is in a bad\nstate.",
"The resource is known not to be supported."
],
"type": "string"
},
"analysisStatusError": {
"$ref": "Status",
"description": "When an error is encountered this will contain a LocalizedMessage under\ndetails to show to the user. The LocalizedMessage output only and\npopulated by the API."
},
"continuousAnalysis": {
"description": "Whether the resource is continuously analyzed.",
"enum": [
"CONTINUOUS_ANALYSIS_UNSPECIFIED",
"ACTIVE",
"INACTIVE"
],
"enumDescriptions": [
"Unknown",
"The resource is continuously analyzed.",
"The resource is ignored for continuous analysis."
],
"type": "string"
},
"cpe": {
"description": "The CPE of the resource being scanned.",
"type": "string"
},
"operation": {
"$ref": "Operation",
"description": "Output only. An operation that indicates the status of the current scan.\nThis field is deprecated, do not use."
}
},
"type": "object"
},
"Discovery": {
"description": "A note that indicates a type of analysis a provider would perform. This note\nexists in a provider's project. A `Discovery` occurrence is created in a\nconsumer's project at the start of analysis. The occurrence's operation will\nindicate the status of the analysis. Absence of an occurrence linked to this\nnote for a resource indicates that analysis hasn't started.",
"id": "Discovery",
"properties": {
"analysisKind": {
"description": "The kind of analysis that is handled by this discovery.",
"enum": [
"KIND_UNSPECIFIED",
"PACKAGE_VULNERABILITY",
"BUILD_DETAILS",
"IMAGE_BASIS",
"PACKAGE_MANAGER",
"DEPLOYABLE",
"DISCOVERY",
"ATTESTATION_AUTHORITY",
"UPGRADE"
],
"enumDescriptions": [
"Unknown",
"The note and occurrence represent a package vulnerability.",
"The note and occurrence assert build provenance.",
"This represents an image basis relationship.",
"This represents a package installed via a package manager.",
"The note and occurrence track deployment events.",
"The note and occurrence track the initial discovery status of a resource.",
"This represents a logical \"role\" that can attest to artifacts.",
"This represents an available software upgrade."
],
"type": "string"
}
},
"type": "object"
},
"Distribution": {
"description": "This represents a particular channel of distribution for a given package.\ne.g. Debian's jessie-backports dpkg mirror",
"id": "Distribution",
"properties": {
"architecture": {
"description": "The CPU architecture for which packages in this distribution\nchannel were built",
"enum": [
"ARCHITECTURE_UNSPECIFIED",
"X86",
"X64"
],
"enumDescriptions": [
"Unknown architecture",
"X86 architecture",
"X64 architecture"
],
"type": "string"
},
"cpeUri": {
"description": "The cpe_uri in [cpe format](https://cpe.mitre.org/specification/)\ndenoting the package manager version distributing a package.",
"type": "string"
},
"description": {
"description": "The distribution channel-specific description of this package.",
"type": "string"
},
"latestVersion": {
"$ref": "Version",
"description": "The latest available version of this package in\nthis distribution channel."
},
"maintainer": {
"description": "A freeform string denoting the maintainer of this package.",
"type": "string"
},
"url": {
"description": "The distribution channel-specific homepage for this package.",
"type": "string"
}
},
"type": "object"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"id": "Empty",
"properties": {},
"type": "object"
},
"Expr": {
"description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"",
"id": "Expr",
"properties": {
"description": {
"description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
"type": "string"
},
"expression": {
"description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.",
"type": "string"
},
"location": {
"description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.",
"type": "string"
},
"title": {
"description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
"type": "string"
}
},
"type": "object"
},
"FileHashes": {
"description": "Container message for hashes of byte content of files, used in Source\nmessages to verify integrity of source input to the build.",
"id": "FileHashes",
"properties": {
"fileHash": {
"description": "Collection of file hashes.",
"items": {
"$ref": "Hash"
},
"type": "array"
}
},
"type": "object"
},
"Fingerprint": {
"description": "A set of properties that uniquely identify a given Docker image.",
"id": "Fingerprint",
"properties": {
"v1Name": {
"description": "The layer-id of the final layer in the Docker image's v1\nrepresentation.\nThis field can be used as a filter in list requests.",
"type": "string"
},
"v2Blob": {
"description": "The ordered list of v2 blobs that represent a given image.",
"items": {
"type": "string"
},
"type": "array"
},
"v2Name": {
"description": "Output only. The name of the image's v2 blobs computed via:\n [bottom] := v2_blobbottom := sha256(v2_blob[N] + \" \" + v2_name[N+1])\nOnly the name of the final blob is kept.\nThis field can be used as a filter in list requests.",
"type": "string"
}
},
"type": "object"
},
"GetIamPolicyRequest": {
"description": "Request message for `GetIamPolicy` method.",
"id": "GetIamPolicyRequest",
"properties": {
"options": {
"$ref": "GetPolicyOptions",
"description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to\n`GetIamPolicy`. This field is only used by Cloud IAM."
}
},
"type": "object"
},
"GetPolicyOptions": {
"description": "Encapsulates settings provided to GetIamPolicy.",
"id": "GetPolicyOptions",
"properties": {
"requestedPolicyVersion": {
"description": "Optional. The policy format version to be returned.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nRequests for policies with any conditional bindings must specify version 3.\nPolicies without any conditional bindings may specify any valid value or\nleave the field unset.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"GetVulnzOccurrencesSummaryResponse": {
"description": "A summary of how many vulnz occurrences there are per severity type.\ncounts by groups, or if we should have different summary messages\nlike this.",
"id": "GetVulnzOccurrencesSummaryResponse",
"properties": {
"counts": {
"description": "A map of how many occurrences were found for each severity.",
"items": {
"$ref": "SeverityCount"
},
"type": "array"
}
},
"type": "object"
},
"GoogleDevtoolsContaineranalysisV1alpha1AliasContext": {
"description": "An alias to a repo revision.",
"id": "GoogleDevtoolsContaineranalysisV1alpha1AliasContext",
"properties": {
"kind": {
"description": "The alias kind.",
"enum": [
"KIND_UNSPECIFIED",
"FIXED",
"MOVABLE",
"OTHER"
],
"enumDescriptions": [
"Unknown.",
"Git tag.",
"Git branch.",
"Used to specify non-standard aliases. For example, if a Git repo has a\nref named \"refs/foo/bar\"."
],
"type": "string"
},
"name": {
"description": "The alias name.",
"type": "string"
}
},
"type": "object"
},
"GoogleDevtoolsContaineranalysisV1alpha1CloudRepoSourceContext": {
"description": "A CloudRepoSourceContext denotes a particular revision in a Google Cloud\nSource Repo.",
"id": "GoogleDevtoolsContaineranalysisV1alpha1CloudRepoSourceContext",
"properties": {
"aliasContext": {
"$ref": "GoogleDevtoolsContaineranalysisV1alpha1AliasContext",
"description": "An alias, which may be a branch or tag."
},
"repoId": {
"$ref": "GoogleDevtoolsContaineranalysisV1alpha1RepoId",
"description": "The ID of the repo."
},
"revisionId": {
"description": "A revision ID.",
"type": "string"
}
},
"type": "object"
},
"GoogleDevtoolsContaineranalysisV1alpha1GerritSourceContext": {
"description": "A SourceContext referring to a Gerrit project.",
"id": "GoogleDevtoolsContaineranalysisV1alpha1GerritSourceContext",
"properties": {
"aliasContext": {
"$ref": "GoogleDevtoolsContaineranalysisV1alpha1AliasContext",
"description": "An alias, which may be a branch or tag."
},
"gerritProject": {
"description": "The full project name within the host. Projects may be nested, so\n\"project/subproject\" is a valid project name. The \"repo name\" is\nthe hostURI/project.",
"type": "string"
},
"hostUri": {
"description": "The URI of a running Gerrit instance.",
"type": "string"
},
"revisionId": {
"description": "A revision (commit) ID.",
"type": "string"
}
},
"type": "object"
},
"GoogleDevtoolsContaineranalysisV1alpha1GitSourceContext": {
"description": "A GitSourceContext denotes a particular revision in a third party Git\nrepository (e.g., GitHub).",
"id": "GoogleDevtoolsContaineranalysisV1alpha1GitSourceContext",
"properties": {
"revisionId": {
"description": "Required. Git commit hash.",
"type": "string"
},
"url": {
"description": "Git repository URL.",
"type": "string"
}
},
"type": "object"
},
"GoogleDevtoolsContaineranalysisV1alpha1OperationMetadata": {
"description": "Metadata for all operations used and required for all operations\nthat created by Container Analysis Providers",
"id": "GoogleDevtoolsContaineranalysisV1alpha1OperationMetadata",
"properties": {
"createTime": {
"description": "Output only. The time this operation was created.",
"format": "google-datetime",
"type": "string"
},
"endTime": {
"description": "Output only. The time that this operation was marked completed or failed.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"GoogleDevtoolsContaineranalysisV1alpha1ProjectRepoId": {
"description": "Selects a repo using a Google Cloud Platform project ID (e.g.,\nwinged-cargo-31) and a repo name within that project.",
"id": "GoogleDevtoolsContaineranalysisV1alpha1ProjectRepoId",
"properties": {
"projectId": {
"description": "The ID of the project.",
"type": "string"
},
"repoName": {
"description": "The name of the repo. Leave empty for the default repo.",
"type": "string"
}
},
"type": "object"
},
"GoogleDevtoolsContaineranalysisV1alpha1RepoId": {
"description": "A unique identifier for a Cloud Repo.",
"id": "GoogleDevtoolsContaineranalysisV1alpha1RepoId",
"properties": {
"projectRepoId": {
"$ref": "GoogleDevtoolsContaineranalysisV1alpha1ProjectRepoId",
"description": "A combination of a project ID and a repo name."
},
"uid": {
"description": "A server-assigned, globally unique identifier.",
"type": "string"
}
},
"type": "object"
},
"GoogleDevtoolsContaineranalysisV1alpha1SourceContext": {
"description": "A SourceContext is a reference to a tree of files. A SourceContext together\nwith a path point to a unique revision of a single file or directory.",
"id": "GoogleDevtoolsContaineranalysisV1alpha1SourceContext",
"properties": {
"cloudRepo": {
"$ref": "GoogleDevtoolsContaineranalysisV1alpha1CloudRepoSourceContext",
"description": "A SourceContext referring to a revision in a Google Cloud Source Repo."
},
"gerrit": {
"$ref": "GoogleDevtoolsContaineranalysisV1alpha1GerritSourceContext",
"description": "A SourceContext referring to a Gerrit project."
},
"git": {
"$ref": "GoogleDevtoolsContaineranalysisV1alpha1GitSourceContext",
"description": "A SourceContext referring to any third party Git repo (e.g., GitHub)."
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels with user defined metadata.",
"type": "object"
}
},
"type": "object"
},
"Hash": {
"description": "Container message for hash values.",
"id": "Hash",
"properties": {
"type": {
"description": "The type of hash that was performed.",
"enum": [
"NONE",
"SHA256"
],
"enumDescriptions": [
"No hash requested.",
"A sha256 hash."
],
"type": "string"
},
"value": {
"description": "The hash value.",
"format": "byte",
"type": "string"
}
},
"type": "object"
},
"Installation": {
"description": "This represents how a particular software package may be installed on\na system.",
"id": "Installation",
"properties": {
"location": {
"description": "All of the places within the filesystem versions of this package\nhave been found.",
"items": {
"$ref": "Location"
},
"type": "array"
},
"name": {
"description": "Output only. The name of the installed package.",
"type": "string"
}
},
"type": "object"
},
"Layer": {
"description": "Layer holds metadata specific to a layer of a Docker image.",
"id": "Layer",
"properties": {
"arguments": {
"description": "The recovered arguments to the Dockerfile directive.",
"type": "string"
},
"directive": {
"description": "The recovered Dockerfile directive used to construct this layer.",
"enum": [
"DIRECTIVE_UNSPECIFIED",
"MAINTAINER",
"RUN",
"CMD",
"LABEL",
"EXPOSE",
"ENV",
"ADD",
"COPY",
"ENTRYPOINT",
"VOLUME",
"USER",
"WORKDIR",
"ARG",
"ONBUILD",
"STOPSIGNAL",
"HEALTHCHECK",
"SHELL"
],
"enumDescriptions": [
"Default value for unsupported/missing directive",
"https://docs.docker.com/engine/reference/builder/",
"https://docs.docker.com/engine/reference/builder/",
"https://docs.docker.com/engine/reference/builder/",
"https://docs.docker.com/engine/reference/builder/",
"https://docs.docker.com/engine/reference/builder/",
"https://docs.docker.com/engine/reference/builder/",
"https://docs.docker.com/engine/reference/builder/",
"https://docs.docker.com/reference/builder/#copy",
"https://docs.docker.com/engine/reference/builder/",
"https://docs.docker.com/engine/reference/builder/",
"https://docs.docker.com/engine/reference/builder/",
"https://docs.docker.com/engine/reference/builder/",
"https://docs.docker.com/engine/reference/builder/",
"https://docs.docker.com/engine/reference/builder/",
"https://docs.docker.com/engine/reference/builder/",
"https://docs.docker.com/engine/reference/builder/",
"https://docs.docker.com/engine/reference/builder/"
],
"type": "string"
}
},
"type": "object"
},
"ListNoteOccurrencesResponse": {
"description": "Response including listed occurrences for a note.",
"id": "ListNoteOccurrencesResponse",
"properties": {
"nextPageToken": {
"description": "Token to receive the next page of notes.",
"type": "string"
},
"occurrences": {
"description": "The occurrences attached to the specified note.",
"items": {
"$ref": "Occurrence"
},
"type": "array"
}
},
"type": "object"
},
"ListNotesResponse": {
"description": "Response including listed notes.",
"id": "ListNotesResponse",
"properties": {
"nextPageToken": {
"description": "The next pagination token in the list response. It should be used as\npage_token for the following request. An empty value means no more result.",
"type": "string"
},
"notes": {
"description": "The occurrences requested",
"items": {
"$ref": "Note"
},
"type": "array"
}
},
"type": "object"
},
"ListOccurrencesResponse": {
"description": "Response including listed active occurrences.",
"id": "ListOccurrencesResponse",
"properties": {
"nextPageToken": {
"description": "The next pagination token in the list response. It should be used as\n`page_token` for the following request. An empty value means no more\nresults.",
"type": "string"
},
"occurrences": {
"description": "The occurrences requested.",
"items": {
"$ref": "Occurrence"
},
"type": "array"
}
},
"type": "object"
},
"ListScanConfigsResponse": {
"description": "A list of scan configs for the project.",
"id": "ListScanConfigsResponse",
"properties": {
"nextPageToken": {
"description": "A page token to pass in order to get more scan configs.",
"type": "string"
},
"scanConfigs": {
"description": "The set of scan configs.",
"items": {
"$ref": "ScanConfig"
},
"type": "array"
}
},
"type": "object"
},
"Location": {
"description": "An occurrence of a particular package installation found within a\nsystem's filesystem.\ne.g. glibc was found in /var/lib/dpkg/status",
"id": "Location",
"properties": {
"cpeUri": {
"description": "The cpe_uri in [cpe format](https://cpe.mitre.org/specification/)\ndenoting the package manager version distributing a package.",
"type": "string"
},
"path": {
"description": "The path from which we gathered that this package/version is installed.",
"type": "string"
},
"version": {
"$ref": "Version",
"description": "The version installed at this location."
}
},
"type": "object"
},
"Note": {
"description": "Provides a detailed description of a `Note`.",
"id": "Note",
"properties": {
"attestationAuthority": {
"$ref": "AttestationAuthority",
"description": "A note describing an attestation role."
},
"baseImage": {
"$ref": "Basis",
"description": "A note describing a base image."
},
"buildType": {
"$ref": "BuildType",
"description": "Build provenance type for a verifiable build."
},
"createTime": {
"description": "Output only. The time this note was created. This field can be used as a\nfilter in list requests.",
"format": "google-datetime",
"type": "string"
},
"deployable": {
"$ref": "Deployable",
"description": "A note describing something that can be deployed."
},
"discovery": {
"$ref": "Discovery",
"description": "A note describing a provider/analysis type."
},
"expirationTime": {
"description": "Time of expiration for this note, null if note does not expire.",
"format": "google-datetime",
"type": "string"
},
"kind": {
"description": "Output only. This explicitly denotes which kind of note is specified. This\nfield can be used as a filter in list requests.",
"enum": [
"KIND_UNSPECIFIED",
"PACKAGE_VULNERABILITY",
"BUILD_DETAILS",
"IMAGE_BASIS",
"PACKAGE_MANAGER",
"DEPLOYABLE",
"DISCOVERY",
"ATTESTATION_AUTHORITY",
"UPGRADE"
],
"enumDescriptions": [
"Unknown",
"The note and occurrence represent a package vulnerability.",
"The note and occurrence assert build provenance.",
"This represents an image basis relationship.",
"This represents a package installed via a package manager.",
"The note and occurrence track deployment events.",
"The note and occurrence track the initial discovery status of a resource.",
"This represents a logical \"role\" that can attest to artifacts.",
"This represents an available software upgrade."
],
"type": "string"
},
"longDescription": {
"description": "A detailed description of this `Note`.",
"type": "string"
},
"name": {
"description": "The name of the note in the form\n\"projects/{provider_project_id}/notes/{NOTE_ID}\"",
"type": "string"
},
"package": {
"$ref": "Package",
"description": "A note describing a package hosted by various package managers."
},
"relatedUrl": {
"description": "URLs associated with this note",
"items": {
"$ref": "RelatedUrl"
},
"type": "array"
},
"shortDescription": {
"description": "A one sentence description of this `Note`.",
"type": "string"
},
"updateTime": {
"description": "Output only. The time this note was last updated. This field can be used as\na filter in list requests.",
"format": "google-datetime",
"type": "string"
},
"upgrade": {
"$ref": "UpgradeNote",
"description": "A note describing an upgrade."
},
"vulnerabilityType": {
"$ref": "VulnerabilityType",
"description": "A package vulnerability type of note."
}
},
"type": "object"
},
"Occurrence": {
"description": "`Occurrence` includes information about analysis occurrences for an image.",
"id": "Occurrence",
"properties": {
"attestation": {
"$ref": "Attestation",
"description": "Describes an attestation of an artifact."
},
"buildDetails": {
"$ref": "BuildDetails",
"description": "Build details for a verifiable build."
},
"createTime": {
"description": "Output only. The time this `Occurrence` was created.",
"format": "google-datetime",
"type": "string"
},
"deployment": {
"$ref": "Deployment",
"description": "Describes the deployment of an artifact on a runtime."
},
"derivedImage": {
"$ref": "Derived",
"description": "Describes how this resource derives from the basis\nin the associated note."
},
"discovered": {
"$ref": "Discovered",
"description": "Describes the initial scan status for this resource."
},
"installation": {
"$ref": "Installation",
"description": "Describes the installation of a package on the linked resource."
},
"kind": {
"description": "Output only. This explicitly denotes which of the `Occurrence` details are\nspecified. This field can be used as a filter in list requests.",
"enum": [
"KIND_UNSPECIFIED",
"PACKAGE_VULNERABILITY",
"BUILD_DETAILS",
"IMAGE_BASIS",
"PACKAGE_MANAGER",
"DEPLOYABLE",
"DISCOVERY",
"ATTESTATION_AUTHORITY",
"UPGRADE"
],
"enumDescriptions": [
"Unknown",
"The note and occurrence represent a package vulnerability.",
"The note and occurrence assert build provenance.",
"This represents an image basis relationship.",
"This represents a package installed via a package manager.",
"The note and occurrence track deployment events.",
"The note and occurrence track the initial discovery status of a resource.",
"This represents a logical \"role\" that can attest to artifacts.",
"This represents an available software upgrade."
],
"type": "string"
},
"name": {
"description": "Output only. The name of the `Occurrence` in the form\n\"projects/{project_id}/occurrences/{OCCURRENCE_ID}\"",
"type": "string"
},
"noteName": {
"description": "An analysis note associated with this image, in the form\n\"providers/{provider_id}/notes/{NOTE_ID}\"\nThis field can be used as a filter in list requests.",
"type": "string"
},
"remediation": {
"description": "A description of actions that can be taken to remedy the `Note`",
"type": "string"
},
"resource": {
"$ref": "Resource",
"description": "\nThe resource for which the `Occurrence` applies."
},
"resourceUrl": {
"description": "The unique URL of the image or the container for which the `Occurrence`\napplies. For example, https://gcr.io/project/image@sha256:foo This field\ncan be used as a filter in list requests.",
"type": "string"
},
"updateTime": {
"description": "Output only. The time this `Occurrence` was last updated.",
"format": "google-datetime",
"type": "string"
},
"upgrade": {
"$ref": "UpgradeOccurrence",
"description": "Describes an upgrade."
},
"vulnerabilityDetails": {
"$ref": "VulnerabilityDetails",
"description": "Details of a security vulnerability note."
}
},
"type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a\nnetwork API call.",
"id": "Operation",
"properties": {
"done": {
"description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.",
"type": "boolean"
},
"error": {
"$ref": "Status",
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.",
"type": "object"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should be a resource name ending with `operations/{unique_id}`.",
"type": "string"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.",
"type": "object"
}
},
"type": "object"
},
"Package": {
"description": "This represents a particular package that is distributed over\nvarious channels.\ne.g. glibc (aka libc6) is distributed by many, at various versions.",
"id": "Package",
"properties": {
"distribution": {
"description": "The various channels by which a package is distributed.",
"items": {
"$ref": "Distribution"
},
"type": "array"
},
"name": {
"description": "The name of the package.",
"type": "string"
}
},
"type": "object"
},
"PackageIssue": {
"description": "This message wraps a location affected by a vulnerability and its\nassociated fix (if one is available).",
"id": "PackageIssue",
"properties": {
"affectedLocation": {
"$ref": "VulnerabilityLocation",
"description": "The location of the vulnerability."
},
"fixedLocation": {
"$ref": "VulnerabilityLocation",
"description": "The location of the available fix for vulnerability."
},
"severityName": {
"type": "string"
}
},
"type": "object"
},
"PgpSignedAttestation": {
"description": "An attestation wrapper with a PGP-compatible signature.\nThis message only supports `ATTACHED` signatures, where the payload that is\nsigned is included alongside the signature itself in the same file.",
"id": "PgpSignedAttestation",
"properties": {
"contentType": {
"description": "Type (for example schema) of the attestation payload that was signed.\nThe verifier must ensure that the provided type is one that the verifier\nsupports, and that the attestation payload is a valid instantiation of that\ntype (for example by validating a JSON schema).",
"enum": [
"CONTENT_TYPE_UNSPECIFIED",
"SIMPLE_SIGNING_JSON"
],
"enumDescriptions": [
"`ContentType` is not set.",
"Atomic format attestation signature. See\nhttps://github.com/containers/image/blob/8a5d2f82a6e3263290c8e0276c3e0f64e77723e7/docs/atomic-signature.md\nThe payload extracted from `signature` is a JSON blob conforming to the\nlinked schema."
],
"type": "string"
},
"pgpKeyId": {
"description": "The cryptographic fingerprint of the key used to generate the signature,\nas output by, e.g. `gpg --list-keys`. This should be the version 4, full\n160-bit fingerprint, expressed as a 40 character hexadecimal string. See\nhttps://tools.ietf.org/html/rfc4880#section-12.2 for details.\nImplementations may choose to acknowledge \"LONG\", \"SHORT\", or other\nabbreviated key IDs, but only the full fingerprint is guaranteed to work.\nIn gpg, the full fingerprint can be retrieved from the `fpr` field\nreturned when calling --list-keys with --with-colons. For example:\n```\ngpg --with-colons --with-fingerprint --force-v4-certs \\\n --list-keys attester@example.com\ntru::1:1513631572:0:3:1:5\npub:...\u003cSNIP\u003e...\nfpr:::::::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB:\n```\nAbove, the fingerprint is `24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`.",
"type": "string"
},
"signature": {
"description": "The raw content of the signature, as output by GNU Privacy Guard (GPG) or\nequivalent. Since this message only supports attached signatures, the\npayload that was signed must be attached. While the signature format\nsupported is dependent on the verification implementation, currently only\nASCII-armored (`--armor` to gpg), non-clearsigned (`--sign` rather than\n`--clearsign` to gpg) are supported. Concretely, `gpg --sign --armor\n--output=signature.gpg payload.json` will create the signature content\nexpected in this field in `signature.gpg` for the `payload.json`\nattestation payload.",
"type": "string"
}
},
"type": "object"
},
"Policy": {
"description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members` to a single `role`. Members can be user accounts, service accounts,\nGoogle groups, and domains (such as G Suite). A `role` is a named list of\npermissions (defined by IAM or configured by users). A `binding` can\noptionally specify a `condition`, which is a logic expression that further\nconstrains the role binding based on attributes about the request and/or\ntarget resource.\n\n**JSON Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/resourcemanager.organizationAdmin\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n ]\n },\n {\n \"role\": \"roles/resourcemanager.organizationViewer\",\n \"members\": [\"user:eve@example.com\"],\n \"condition\": {\n \"title\": \"expirable access\",\n \"description\": \"Does not grant access after Sep 2020\",\n \"expression\": \"request.time \u003c\n timestamp('2020-10-01T00:00:00.000Z')\",\n }\n }\n ]\n }\n\n**YAML Example**\n\n bindings:\n - members:\n - user:mike@example.com\n - group:admins@example.com\n - domain:google.com\n - serviceAccount:my-project-id@appspot.gserviceaccount.com\n role: roles/resourcemanager.organizationAdmin\n - members:\n - user:eve@example.com\n role: roles/resourcemanager.organizationViewer\n condition:\n title: expirable access\n description: Does not grant access after Sep 2020\n expression: request.time \u003c timestamp('2020-10-01T00:00:00.000Z')\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).",
"id": "Policy",
"properties": {
"bindings": {
"description": "Associates a list of `members` to a `role`. Optionally may specify a\n`condition` that determines when binding is in effect.\n`bindings` with no members will result in an error.",
"items": {
"$ref": "Binding"
},
"type": "array"
},
"etag": {
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten. Due to blind-set semantics of an etag-less policy,\n'setIamPolicy' will not fail even if the incoming policy version does not\nmeet the requirements for modifying the stored policy.",
"format": "byte",
"type": "string"
},
"version": {
"description": "Specifies the format of the policy.\n\nValid values are 0, 1, and 3. Requests specifying an invalid value will be\nrejected.\n\nOperations affecting conditional bindings must specify version 3. This can\nbe either setting a conditional policy, modifying a conditional binding,\nor removing a binding (conditional or unconditional) from the stored\nconditional policy.\nOperations on non-conditional policies may specify any valid value or\nleave the field unset.\n\nIf no etag is provided in the call to `setIamPolicy`, version compliance\nchecks against the stored policy is skipped.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"RelatedUrl": {
"description": "Metadata for any related URL information",
"id": "RelatedUrl",
"properties": {
"label": {
"description": "Label to describe usage of the URL",
"type": "string"
},
"url": {
"description": "Specific URL to associate with the note",
"type": "string"
}
},
"type": "object"
},
"RepoSource": {
"description": "RepoSource describes the location of the source in a Google Cloud Source\nRepository.",
"id": "RepoSource",
"properties": {
"branchName": {
"description": "Name of the branch to build.",
"type": "string"
},
"commitSha": {
"description": "Explicit commit SHA to build.",
"type": "string"
},
"projectId": {
"description": "ID of the project that owns the repo.",
"type": "string"
},
"repoName": {
"description": "Name of the repo.",
"type": "string"
},
"tagName": {
"description": "Name of the tag to build.",
"type": "string"
}
},
"type": "object"
},
"Resource": {
"description": "\nResource is an entity that can have metadata. E.g., a Docker image.",
"id": "Resource",
"properties": {
"contentHash": {
"$ref": "Hash",
"description": "The hash of the resource content. E.g., the Docker digest."
},
"name": {
"description": "The name of the resource. E.g., the name of a Docker image - \"Debian\".",
"type": "string"
},
"uri": {
"description": "The unique URI of the resource. E.g.,\n\"https://gcr.io/project/image@sha256:foo\" for a Docker image.",
"type": "string"
}
},
"type": "object"
},
"ScanConfig": {
"description": "Indicates various scans and whether they are turned on or off.",
"id": "ScanConfig",
"properties": {
"createTime": {
"description": "Output only. The time this scan config was created.",
"format": "google-datetime",
"type": "string"
},
"description": {
"description": "Output only. A human-readable description of what the `ScanConfig` does.",
"type": "string"
},
"enabled": {
"description": "Indicates whether the Scan is enabled.",
"type": "boolean"
},
"name": {
"description": "Output only. The name of the ScanConfig in the form\n“projects/{project_id}/scanConfigs/{scan_config_id}\".",
"type": "string"
},
"updateTime": {
"description": "Output only. The time this scan config was last updated.",
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"SetIamPolicyRequest": {
"description": "Request message for `SetIamPolicy` method.",
"id": "SetIamPolicyRequest",
"properties": {
"policy": {
"$ref": "Policy",
"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them."
}
},
"type": "object"
},
"SeverityCount": {
"description": "The number of occurrences created for a specific severity.",
"id": "SeverityCount",
"properties": {
"count": {
"description": "The number of occurrences with the severity.",
"format": "int64",
"type": "string"
},
"severity": {
"description": "The severity of the occurrences.",
"enum": [
"SEVERITY_UNSPECIFIED",
"MINIMAL",
"LOW",
"MEDIUM",
"HIGH",
"CRITICAL"
],
"enumDescriptions": [
"Unknown Impact",
"Minimal Impact",
"Low Impact",
"Medium Impact",
"High Impact",
"Critical Impact"
],
"type": "string"
}
},
"type": "object"
},
"Source": {
"description": "Source describes the location of the source used for the build.",
"id": "Source",
"properties": {
"additionalContexts": {
"description": "If provided, some of the source code used for the build may be found in\nthese locations, in the case where the source repository had multiple\nremotes or submodules. This list will not include the context specified in\nthe context field.",
"items": {
"$ref": "GoogleDevtoolsContaineranalysisV1alpha1SourceContext"
},
"type": "array"
},
"artifactStorageSource": {
"$ref": "StorageSource",
"description": "If provided, the input binary artifacts for the build came from this\nlocation."
},
"context": {
"$ref": "GoogleDevtoolsContaineranalysisV1alpha1SourceContext",
"description": "If provided, the source code used for the build came from this location."
},
"fileHashes": {
"additionalProperties": {
"$ref": "FileHashes"
},
"description": "Hash(es) of the build source, which can be used to verify that the original\nsource integrity was maintained in the build.\n\nThe keys to this map are file paths used as build source and the values\ncontain the hash values for those files.\n\nIf the build source came in a single package such as a gzipped tarfile\n(.tar.gz), the FileHash will be for the single path to that file.",
"type": "object"
},
"repoSource": {
"$ref": "RepoSource",
"description": "If provided, get source from this location in a Cloud Repo."
},
"storageSource": {
"$ref": "StorageSource",
"description": "If provided, get the source from this location in in Google Cloud\nStorage."
}
},
"type": "object"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).",
"id": "Status",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
"type": "object"
},
"StorageSource": {
"description": "StorageSource describes the location of the source in an archive file in\nGoogle Cloud Storage.",
"id": "StorageSource",
"properties": {
"bucket": {
"description": "Google Cloud Storage bucket containing source (see [Bucket Name\nRequirements]\n(https://cloud.google.com/storage/docs/bucket-naming#requirements)).",
"type": "string"
},
"generation": {
"description": "Google Cloud Storage generation for the object.",
"format": "int64",
"type": "string"
},
"object": {
"description": "Google Cloud Storage object containing source.",
"type": "string"
}
},
"type": "object"
},
"TestIamPermissionsRequest": {
"description": "Request message for `TestIamPermissions` method.",
"id": "TestIamPermissionsRequest",
"properties": {
"permissions": {
"description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TestIamPermissionsResponse": {
"description": "Response message for `TestIamPermissions` method.",
"id": "TestIamPermissionsResponse",
"properties": {
"permissions": {
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"UpdateOperationRequest": {
"description": "Request for updating an existing operation",
"id": "UpdateOperationRequest",
"properties": {
"operation": {
"$ref": "Operation",
"description": "The operation to create."
},
"updateMask": {
"description": "The fields to update.",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"UpgradeDistribution": {
"description": "The Upgrade Distribution represents metadata about the Upgrade for each\noperating system (CPE). Some distributions have additional metadata around\nupdates, classifying them into various categories and severities.",
"id": "UpgradeDistribution",
"properties": {
"classification": {
"description": "The operating system classification of this Upgrade, as specified by the\nupstream operating system upgrade feed.",
"type": "string"
},
"cpeUri": {
"description": "Required - The specific operating system this metadata applies to. See\nhttps://cpe.mitre.org/specification/.",
"type": "string"
},
"cve": {
"description": "The cve that would be resolved by this upgrade.",
"items": {
"type": "string"
},
"type": "array"
},
"severity": {
"description": "The severity as specified by the upstream operating system.",
"type": "string"
}
},
"type": "object"
},
"UpgradeNote": {
"description": "An Upgrade Note represents a potential upgrade of a package to a given\nversion. For each package version combination (i.e. bash 4.0, bash 4.1,\nbash 4.1.2), there will be a Upgrade Note.",
"id": "UpgradeNote",
"properties": {
"distributions": {
"description": "Metadata about the upgrade for each specific operating system.",
"items": {
"$ref": "UpgradeDistribution"
},
"type": "array"
},
"package": {
"description": "Required - The package this Upgrade is for.",
"type": "string"
},
"version": {
"$ref": "Version",
"description": "Required - The version of the package in machine + human readable form."
}
},
"type": "object"
},
"UpgradeOccurrence": {
"description": "An Upgrade Occurrence represents that a specific resource_url could install a\nspecific upgrade. This presence is supplied via local sources (i.e. it is\npresent in the mirror and the running system has noticed its availability).",
"id": "UpgradeOccurrence",
"properties": {
"distribution": {
"$ref": "UpgradeDistribution",
"description": "Metadata about the upgrade for available for the specific operating system\nfor the resource_url. This allows efficient filtering, as well as\nmaking it easier to use the occurrence."
},
"package": {
"description": "Required - The package this Upgrade is for.",
"type": "string"
},
"parsedVersion": {
"$ref": "Version",
"description": "Required - The version of the package in a machine + human readable form."
}
},
"type": "object"
},
"Version": {
"description": "Version contains structured information about the version of the package.\nFor a discussion of this in Debian/Ubuntu:\nhttp://serverfault.com/questions/604541/debian-packages-version-convention\nFor a discussion of this in Redhat/Fedora/Centos:\nhttp://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/",
"id": "Version",
"properties": {
"epoch": {
"description": "Used to correct mistakes in the version numbering scheme.",
"format": "int32",
"type": "integer"
},
"kind": {
"description": "Distinguish between sentinel MIN/MAX versions and normal versions.\nIf kind is not NORMAL, then the other fields are ignored.",
"enum": [
"NORMAL",
"MINIMUM",
"MAXIMUM"
],
"enumDescriptions": [
"A standard package version, defined by the other fields.",
"A special version representing negative infinity,\nother fields are ignored.",
"A special version representing positive infinity,\nother fields are ignored."
],
"type": "string"
},
"name": {
"description": "The main part of the version name.",
"type": "string"
},
"revision": {
"description": "The iteration of the package build from the above version.",
"type": "string"
}
},
"type": "object"
},
"VulnerabilityDetails": {
"description": "Used by Occurrence to point to where the vulnerability exists and how\nto fix it.",
"id": "VulnerabilityDetails",
"properties": {
"cvssScore": {
"description": "Output only. The CVSS score of this vulnerability. CVSS score is on a\nscale of 0-10 where 0 indicates low severity and 10 indicates high\nseverity.",
"format": "float",
"type": "number"
},
"effectiveSeverity": {
"description": "The distro assigned severity for this vulnerability when that is\navailable and note provider assigned severity when distro has not yet\nassigned a severity for this vulnerability.",
"enum": [
"SEVERITY_UNSPECIFIED",
"MINIMAL",
"LOW",
"MEDIUM",
"HIGH",
"CRITICAL"
],
"enumDescriptions": [
"Unknown Impact",
"Minimal Impact",
"Low Impact",
"Medium Impact",
"High Impact",
"Critical Impact"
],
"type": "string"
},
"packageIssue": {
"description": "The set of affected locations and their fixes (if available) within\nthe associated resource.",
"items": {
"$ref": "PackageIssue"
},
"type": "array"
},
"severity": {
"description": "Output only. The note provider assigned Severity of the vulnerability.",
"enum": [
"SEVERITY_UNSPECIFIED",
"MINIMAL",
"LOW",
"MEDIUM",
"HIGH",
"CRITICAL"
],
"enumDescriptions": [
"Unknown Impact",
"Minimal Impact",
"Low Impact",
"Medium Impact",
"High Impact",
"Critical Impact"
],
"type": "string"
},
"type": {
"description": "The type of package; whether native or non native(ruby gems,\nnode.js packages etc)",
"type": "string"
}
},
"type": "object"
},
"VulnerabilityLocation": {
"description": "The location of the vulnerability",
"id": "VulnerabilityLocation",
"properties": {
"cpeUri": {
"description": "The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)\nformat. Examples include distro or storage location for vulnerable jar.\nThis field can be used as a filter in list requests.",
"type": "string"
},
"package": {
"description": "The package being described.",
"type": "string"
},
"version": {
"$ref": "Version",
"description": "The version of the package being described. This field can be used as a\nfilter in list requests."
}
},
"type": "object"
},
"VulnerabilityType": {
"description": "VulnerabilityType provides metadata about a security vulnerability.",
"id": "VulnerabilityType",
"properties": {
"cvssScore": {
"description": "The CVSS score for this Vulnerability.",
"format": "float",
"type": "number"
},
"details": {
"description": "All information about the package to specifically identify this\nvulnerability. One entry per (version range and cpe_uri) the\npackage vulnerability has manifested in.",
"items": {
"$ref": "Detail"
},
"type": "array"
},
"severity": {
"description": "Note provider assigned impact of the vulnerability",
"enum": [
"SEVERITY_UNSPECIFIED",
"MINIMAL",
"LOW",
"MEDIUM",
"HIGH",
"CRITICAL"
],
"enumDescriptions": [
"Unknown Impact",
"Minimal Impact",
"Low Impact",
"Medium Impact",
"High Impact",
"Critical Impact"
],
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Container Analysis API",
"version": "v1alpha1",
"version_module": true
}