Container Analysis API . projects . scanConfigs

Instance Methods

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Gets the specified scan configuration.

list(parent, pageToken=None, filter=None, pageSize=None, x__xgafv=None)

Lists scan configurations for the specified project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

update(name, body=None, x__xgafv=None)

Updates the specified scan configuration.

Method Details

close()
Close httplib2 connections.
get(name, x__xgafv=None)
Gets the specified scan configuration.

Args:
  name: string, Required. The name of the scan configuration in the form of `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A scan configuration specifies whether Cloud components in a project have a particular type of analysis being run. For example, it can configure whether vulnerability scanning is being done on Docker images or not.
      "name": "A String", # Output only. The name of the scan configuration in the form of `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`.
      "createTime": "A String", # Output only. The time this scan config was created.
      "description": "A String", # Output only. A human-readable description of what the scan configuration does.
      "enabled": True or False, # Whether the scan is enabled.
      "updateTime": "A String", # Output only. The time this scan config was last updated.
    }
list(parent, pageToken=None, filter=None, pageSize=None, x__xgafv=None)
Lists scan configurations for the specified project.

Args:
  parent: string, Required. The name of the project to list scan configurations for in the form of `projects/[PROJECT_ID]`. (required)
  pageToken: string, Token to provide to skip to a particular spot in the list.
  filter: string, Required. The filter expression.
  pageSize: integer, The number of scan configs to return in the list.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for listing scan configurations.
    "nextPageToken": "A String", # The next pagination token in the list response. It should be used as `page_token` for the following request. An empty value means no more results.
    "scanConfigs": [ # The scan configurations requested.
      { # A scan configuration specifies whether Cloud components in a project have a particular type of analysis being run. For example, it can configure whether vulnerability scanning is being done on Docker images or not.
          "name": "A String", # Output only. The name of the scan configuration in the form of `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`.
          "createTime": "A String", # Output only. The time this scan config was created.
          "description": "A String", # Output only. A human-readable description of what the scan configuration does.
          "enabled": True or False, # Whether the scan is enabled.
          "updateTime": "A String", # Output only. The time this scan config was last updated.
        },
    ],
  }
list_next(previous_request, previous_response)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    
update(name, body=None, x__xgafv=None)
Updates the specified scan configuration.

Args:
  name: string, Required. The name of the scan configuration in the form of `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`. (required)
  body: object, The request body.
    The object takes the form of:

{ # A scan configuration specifies whether Cloud components in a project have a particular type of analysis being run. For example, it can configure whether vulnerability scanning is being done on Docker images or not.
    "name": "A String", # Output only. The name of the scan configuration in the form of `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`.
    "createTime": "A String", # Output only. The time this scan config was created.
    "description": "A String", # Output only. A human-readable description of what the scan configuration does.
    "enabled": True or False, # Whether the scan is enabled.
    "updateTime": "A String", # Output only. The time this scan config was last updated.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A scan configuration specifies whether Cloud components in a project have a particular type of analysis being run. For example, it can configure whether vulnerability scanning is being done on Docker images or not.
      "name": "A String", # Output only. The name of the scan configuration in the form of `projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`.
      "createTime": "A String", # Output only. The time this scan config was created.
      "description": "A String", # Output only. A human-readable description of what the scan configuration does.
      "enabled": True or False, # Whether the scan is enabled.
      "updateTime": "A String", # Output only. The time this scan config was last updated.
    }