Container Analysis API . projects . scanConfigs

Instance Methods

get(name, x__xgafv=None)

Gets a specific scan configuration for a project.

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

Lists scan configurations for a project.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(name, body, updateMask=None, x__xgafv=None)

Updates the scan configuration to a new value.

Method Details

get(name, x__xgafv=None)
Gets a specific scan configuration for a project.

Args:
  name: string, The name of the ScanConfig in the form
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:

    { # Indicates various scans and whether they are turned on or off.
      "updateTime": "A String", # Output only. The time this scan config was last updated.
      "description": "A String", # Output only. A human-readable description of what the `ScanConfig` does.
      "enabled": True or False, # Indicates whether the Scan is enabled.
      "createTime": "A String", # Output only. The time this scan config was created.
      "name": "A String", # Output only. The name of the ScanConfig in the form
          # “projects/{project_id}/scanConfigs/{scan_config_id}".
    }
list(parent, pageSize=None, pageToken=None, x__xgafv=None, filter=None)
Lists scan configurations for a project.

Args:
  parent: string, This containers the project Id i.e.: projects/{project_id} (required)
  pageSize: integer, The number of items to return.
  pageToken: string, The page token to use for the next request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  filter: string, The filter expression.

Returns:
  An object of the form:

    { # A list of scan configs for the project.
    "nextPageToken": "A String", # A page token to pass in order to get more scan configs.
    "scanConfigs": [ # The set of scan configs.
      { # Indicates various scans and whether they are turned on or off.
          "updateTime": "A String", # Output only. The time this scan config was last updated.
          "description": "A String", # Output only. A human-readable description of what the `ScanConfig` does.
          "enabled": True or False, # Indicates whether the Scan is enabled.
          "createTime": "A String", # Output only. The time this scan config was created.
          "name": "A String", # Output only. The name of the ScanConfig in the form
              # “projects/{project_id}/scanConfigs/{scan_config_id}".
        },
    ],
  }
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.
    
patch(name, body, updateMask=None, x__xgafv=None)
Updates the scan configuration to a new value.

Args:
  name: string, The scan config to update of the form
projects/{project_id}/scanConfigs/{scan_config_id}. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Indicates various scans and whether they are turned on or off.
    "updateTime": "A String", # Output only. The time this scan config was last updated.
    "description": "A String", # Output only. A human-readable description of what the `ScanConfig` does.
    "enabled": True or False, # Indicates whether the Scan is enabled.
    "createTime": "A String", # Output only. The time this scan config was created.
    "name": "A String", # Output only. The name of the ScanConfig in the form
        # “projects/{project_id}/scanConfigs/{scan_config_id}".
  }

  updateMask: string, The fields to update.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Indicates various scans and whether they are turned on or off.
      "updateTime": "A String", # Output only. The time this scan config was last updated.
      "description": "A String", # Output only. A human-readable description of what the `ScanConfig` does.
      "enabled": True or False, # Indicates whether the Scan is enabled.
      "createTime": "A String", # Output only. The time this scan config was created.
      "name": "A String", # Output only. The name of the ScanConfig in the form
          # “projects/{project_id}/scanConfigs/{scan_config_id}".
    }