Apigee API . organizations . securityMonitoringConditions

Instance Methods

close()

Close httplib2 connections.

create(parent, body=None, securityMonitoringConditionId=None, x__xgafv=None)

Create a security monitoring condition.

delete(name, x__xgafv=None)

Delete a security monitoring condition.

get(name, x__xgafv=None)

Get a security monitoring condition.

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

List security monitoring conditions.

list_next()

Retrieves the next page of results.

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

Update a security monitoring condition.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, securityMonitoringConditionId=None, x__xgafv=None)
Create a security monitoring condition.

Args:
  parent: string, Required. The parent resource name. Format: `organizations/{org}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Security monitoring condition for risk assessment version 2.
  "createTime": "A String", # Output only. The time of the security monitoring condition creation.
  "include": { # Message for the array of resources. For Apigee, the proxies are resources. # Include only these resources.
    "resources": [ # Required. The array of resources. For Apigee, the proxies are resources.
      { # Resource for which we are computing security assessment.
        "name": "A String", # Required. Name of this resource.
        "type": "A String", # Required. Type of this resource.
      },
    ],
  },
  "includeAllResources": { # Message for include_all_resources option. # Include all resources under the scope.
  },
  "name": "A String", # Identifier. Name of the security monitoring condition resource. Format: organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}
  "profile": "A String", # Required. ID of security profile of the security monitoring condition.
  "scope": "A String", # Required. Scope of the security monitoring condition. For Apigee, the environment is the scope of the resources.
  "totalDeployedResources": 42, # Output only. Total number of deployed resources within scope.
  "totalMonitoredResources": 42, # Output only. Total number of monitored resources within this condition.
  "updateTime": "A String", # Output only. The time of the security monitoring condition update.
}

  securityMonitoringConditionId: string, Optional. Optional: The security monitoring condition id. If not specified, a monitoring condition uuid will be generated by the backend. This value should be 4-63 characters, and valid characters are /a-z-/.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Security monitoring condition for risk assessment version 2.
  "createTime": "A String", # Output only. The time of the security monitoring condition creation.
  "include": { # Message for the array of resources. For Apigee, the proxies are resources. # Include only these resources.
    "resources": [ # Required. The array of resources. For Apigee, the proxies are resources.
      { # Resource for which we are computing security assessment.
        "name": "A String", # Required. Name of this resource.
        "type": "A String", # Required. Type of this resource.
      },
    ],
  },
  "includeAllResources": { # Message for include_all_resources option. # Include all resources under the scope.
  },
  "name": "A String", # Identifier. Name of the security monitoring condition resource. Format: organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}
  "profile": "A String", # Required. ID of security profile of the security monitoring condition.
  "scope": "A String", # Required. Scope of the security monitoring condition. For Apigee, the environment is the scope of the resources.
  "totalDeployedResources": 42, # Output only. Total number of deployed resources within scope.
  "totalMonitoredResources": 42, # Output only. Total number of monitored resources within this condition.
  "updateTime": "A String", # Output only. The time of the security monitoring condition update.
}
delete(name, x__xgafv=None)
Delete a security monitoring condition.

Args:
  name: string, Required. The name of the security monitoring condition to delete. Format: `organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}
get(name, x__xgafv=None)
Get a security monitoring condition.

Args:
  name: string, Required. The name of the security monitoring condition to get. Format: `organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Security monitoring condition for risk assessment version 2.
  "createTime": "A String", # Output only. The time of the security monitoring condition creation.
  "include": { # Message for the array of resources. For Apigee, the proxies are resources. # Include only these resources.
    "resources": [ # Required. The array of resources. For Apigee, the proxies are resources.
      { # Resource for which we are computing security assessment.
        "name": "A String", # Required. Name of this resource.
        "type": "A String", # Required. Type of this resource.
      },
    ],
  },
  "includeAllResources": { # Message for include_all_resources option. # Include all resources under the scope.
  },
  "name": "A String", # Identifier. Name of the security monitoring condition resource. Format: organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}
  "profile": "A String", # Required. ID of security profile of the security monitoring condition.
  "scope": "A String", # Required. Scope of the security monitoring condition. For Apigee, the environment is the scope of the resources.
  "totalDeployedResources": 42, # Output only. Total number of deployed resources within scope.
  "totalMonitoredResources": 42, # Output only. Total number of monitored resources within this condition.
  "updateTime": "A String", # Output only. The time of the security monitoring condition update.
}
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
List security monitoring conditions.

Args:
  parent: string, Required. For a specific organization, list all the security monitoring conditions. Format: `organizations/{org}` (required)
  filter: string, Optional. Filter for the monitoring conditions. For example: `profile=profile1 AND scope=env1`
  pageSize: integer, Optional. The maximum number of monitoring conditions to return.
  pageToken: string, Optional. A page token, received from a previous `ListSecurityMonitoringConditions` call. Provide this to retrieve the subsequent page.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for ListSecurityMonitoringConditions.
  "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "securityMonitoringConditions": [ # List of security monitoring conditions in the organization.
    { # Security monitoring condition for risk assessment version 2.
      "createTime": "A String", # Output only. The time of the security monitoring condition creation.
      "include": { # Message for the array of resources. For Apigee, the proxies are resources. # Include only these resources.
        "resources": [ # Required. The array of resources. For Apigee, the proxies are resources.
          { # Resource for which we are computing security assessment.
            "name": "A String", # Required. Name of this resource.
            "type": "A String", # Required. Type of this resource.
          },
        ],
      },
      "includeAllResources": { # Message for include_all_resources option. # Include all resources under the scope.
      },
      "name": "A String", # Identifier. Name of the security monitoring condition resource. Format: organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}
      "profile": "A String", # Required. ID of security profile of the security monitoring condition.
      "scope": "A String", # Required. Scope of the security monitoring condition. For Apigee, the environment is the scope of the resources.
      "totalDeployedResources": 42, # Output only. Total number of deployed resources within scope.
      "totalMonitoredResources": 42, # Output only. Total number of monitored resources within this condition.
      "updateTime": "A String", # Output only. The time of the security monitoring condition update.
    },
  ],
}
list_next()
Retrieves the next page of results.

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

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        
patch(name, body=None, updateMask=None, x__xgafv=None)
Update a security monitoring condition.

Args:
  name: string, Identifier. Name of the security monitoring condition resource. Format: organizations/{org}/securityMonitoringConditions/{security_monitoring_condition} (required)
  body: object, The request body.
    The object takes the form of:

{ # Security monitoring condition for risk assessment version 2.
  "createTime": "A String", # Output only. The time of the security monitoring condition creation.
  "include": { # Message for the array of resources. For Apigee, the proxies are resources. # Include only these resources.
    "resources": [ # Required. The array of resources. For Apigee, the proxies are resources.
      { # Resource for which we are computing security assessment.
        "name": "A String", # Required. Name of this resource.
        "type": "A String", # Required. Type of this resource.
      },
    ],
  },
  "includeAllResources": { # Message for include_all_resources option. # Include all resources under the scope.
  },
  "name": "A String", # Identifier. Name of the security monitoring condition resource. Format: organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}
  "profile": "A String", # Required. ID of security profile of the security monitoring condition.
  "scope": "A String", # Required. Scope of the security monitoring condition. For Apigee, the environment is the scope of the resources.
  "totalDeployedResources": 42, # Output only. Total number of deployed resources within scope.
  "totalMonitoredResources": 42, # Output only. Total number of monitored resources within this condition.
  "updateTime": "A String", # Output only. The time of the security monitoring condition update.
}

  updateMask: string, Optional. The list of fields to update. Valid fields to update are `profile`, `scope`, `include_all_resources`, `include`, and `exclude`.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Security monitoring condition for risk assessment version 2.
  "createTime": "A String", # Output only. The time of the security monitoring condition creation.
  "include": { # Message for the array of resources. For Apigee, the proxies are resources. # Include only these resources.
    "resources": [ # Required. The array of resources. For Apigee, the proxies are resources.
      { # Resource for which we are computing security assessment.
        "name": "A String", # Required. Name of this resource.
        "type": "A String", # Required. Type of this resource.
      },
    ],
  },
  "includeAllResources": { # Message for include_all_resources option. # Include all resources under the scope.
  },
  "name": "A String", # Identifier. Name of the security monitoring condition resource. Format: organizations/{org}/securityMonitoringConditions/{security_monitoring_condition}
  "profile": "A String", # Required. ID of security profile of the security monitoring condition.
  "scope": "A String", # Required. Scope of the security monitoring condition. For Apigee, the environment is the scope of the resources.
  "totalDeployedResources": 42, # Output only. Total number of deployed resources within scope.
  "totalMonitoredResources": 42, # Output only. Total number of monitored resources within this condition.
  "updateTime": "A String", # Output only. The time of the security monitoring condition update.
}