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

Creates a new security profile group in a given organization and location.

Args:
  parent: string, Required. The parent resource of the `SecurityProfileGroup`. Format: `organizations/{organization}/locations/{location}` or `projects/{project}/locations/{location}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # A resource that defines the behavior for various `ProfileType` values.
  "createTime": "A String", # Output only. Resource creation timestamp.
  "customInterceptProfile": "A String", # Optional. Reference to a `SecurityProfile` with the custom intercept configuration.
  "customMirroringProfile": "A String", # Optional. Reference to a `SecurityProfile` with the custom mirroring configuration.
  "dataPathId": "A String", # Output only. Identifier used by the data path. Unique within `{container, location}`.
  "description": "A String", # Optional. An optional description of the profile group. The maximum length is 2048 characters.
  "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
  "labels": { # Optional. Labels as key-value pairs.
    "a_key": "A String",
  },
  "name": "A String", # Immutable. Identifier. Name of the `SecurityProfileGroup` resource. Format: `organizations/{organization}/locations/{location}/securityProfileGroups/{security_profile_group}` or `projects/{project}/locations/{location}/securityProfileGroups/{security_profile_group}`.
  "threatPreventionProfile": "A String", # Optional. Reference to a `SecurityProfile` with the threat prevention configuration.
  "updateTime": "A String", # Output only. Last resource update timestamp.
  "urlFilteringProfile": "A String", # Optional. Reference to a `SecurityProfile` with the URL filtering configuration.
  "wildfireAnalysisProfile": "A String", # Optional. Reference to a `SecurityProfile` with the Advanced malware sandbox (WildFire) configuration.
}

  securityProfileGroupId: string, Required. Short name of the `SecurityProfileGroup` resource to be created. This value must be 1 to 63 characters long, contain only lowercase letters, numbers, and hyphens, and must not start with a number. For example, `security-profile-group1`.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}

delete(name, etag=None, x__xgafv=None)

Deletes a single security profile group.

Args:
name: string, Required. The name of the `SecurityProfileGroup` to delete. Format: `organizations/{organization}/locations/{location}/securityProfileGroups/{security_profile_group}` or `projects/{project}/locations/{location}/securityProfileGroups/{security_profile_group}`. (required)
etag: string, Optional. If the client-provided `etag` is out of date, the delete request returns an `ABORTED` error.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

get(name, x__xgafv=None)

Gets details of a single security profile group.

Args:
  name: string, Required. The name of the `SecurityProfileGroup` to get. Format: `organizations/{organization}/locations/{location}/securityProfileGroups/{security_profile_group}` or `projects/{project}/locations/{location}/securityProfileGroups/{security_profile_group}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A resource that defines the behavior for various `ProfileType` values.
  "createTime": "A String", # Output only. Resource creation timestamp.
  "customInterceptProfile": "A String", # Optional. Reference to a `SecurityProfile` with the custom intercept configuration.
  "customMirroringProfile": "A String", # Optional. Reference to a `SecurityProfile` with the custom mirroring configuration.
  "dataPathId": "A String", # Output only. Identifier used by the data path. Unique within `{container, location}`.
  "description": "A String", # Optional. An optional description of the profile group. The maximum length is 2048 characters.
  "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
  "labels": { # Optional. Labels as key-value pairs.
    "a_key": "A String",
  },
  "name": "A String", # Immutable. Identifier. Name of the `SecurityProfileGroup` resource. Format: `organizations/{organization}/locations/{location}/securityProfileGroups/{security_profile_group}` or `projects/{project}/locations/{location}/securityProfileGroups/{security_profile_group}`.
  "threatPreventionProfile": "A String", # Optional. Reference to a `SecurityProfile` with the threat prevention configuration.
  "updateTime": "A String", # Output only. Last resource update timestamp.
  "urlFilteringProfile": "A String", # Optional. Reference to a `SecurityProfile` with the URL filtering configuration.
  "wildfireAnalysisProfile": "A String", # Optional. Reference to a `SecurityProfile` with the Advanced malware sandbox (WildFire) configuration.
}

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

Lists security profile group resources in a given organization and location.

Args:
  parent: string, Required. The project or organization and location from which the `SecurityProfileGroup` resources are listed. Format: `organizations/{organization}/locations/{location}` or `projects/{project}/locations/{location}`. (required)
  pageSize: integer, Optional. Maximum number of `SecurityProfileGroup` resources to return per call. The maximum value is 1000; values above 1000 are coerced to 1000. If unspecified, the server picks an appropriate default.
  pageToken: string, Optional. A page token, received from a previous `ListSecurityProfileGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSecurityProfileGroups` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response returned by the `ListSecurityProfileGroups` method.
  "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.
  "securityProfileGroups": [ # List of `SecurityProfileGroup` resources.
    { # A resource that defines the behavior for various `ProfileType` values.
      "createTime": "A String", # Output only. Resource creation timestamp.
      "customInterceptProfile": "A String", # Optional. Reference to a `SecurityProfile` with the custom intercept configuration.
      "customMirroringProfile": "A String", # Optional. Reference to a `SecurityProfile` with the custom mirroring configuration.
      "dataPathId": "A String", # Output only. Identifier used by the data path. Unique within `{container, location}`.
      "description": "A String", # Optional. An optional description of the profile group. The maximum length is 2048 characters.
      "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
      "labels": { # Optional. Labels as key-value pairs.
        "a_key": "A String",
      },
      "name": "A String", # Immutable. Identifier. Name of the `SecurityProfileGroup` resource. Format: `organizations/{organization}/locations/{location}/securityProfileGroups/{security_profile_group}` or `projects/{project}/locations/{location}/securityProfileGroups/{security_profile_group}`.
      "threatPreventionProfile": "A String", # Optional. Reference to a `SecurityProfile` with the threat prevention configuration.
      "updateTime": "A String", # Output only. Last resource update timestamp.
      "urlFilteringProfile": "A String", # Optional. Reference to a `SecurityProfile` with the URL filtering configuration.
      "wildfireAnalysisProfile": "A String", # Optional. Reference to a `SecurityProfile` with the Advanced malware sandbox (WildFire) configuration.
    },
  ],
}

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=None, updateMask=None, x__xgafv=None)

Updates the parameters of a single security profile group.

Args:
  name: string, Immutable. Identifier. Name of the `SecurityProfileGroup` resource. Format: `organizations/{organization}/locations/{location}/securityProfileGroups/{security_profile_group}` or `projects/{project}/locations/{location}/securityProfileGroups/{security_profile_group}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # A resource that defines the behavior for various `ProfileType` values.
  "createTime": "A String", # Output only. Resource creation timestamp.
  "customInterceptProfile": "A String", # Optional. Reference to a `SecurityProfile` with the custom intercept configuration.
  "customMirroringProfile": "A String", # Optional. Reference to a `SecurityProfile` with the custom mirroring configuration.
  "dataPathId": "A String", # Output only. Identifier used by the data path. Unique within `{container, location}`.
  "description": "A String", # Optional. An optional description of the profile group. The maximum length is 2048 characters.
  "etag": "A String", # Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
  "labels": { # Optional. Labels as key-value pairs.
    "a_key": "A String",
  },
  "name": "A String", # Immutable. Identifier. Name of the `SecurityProfileGroup` resource. Format: `organizations/{organization}/locations/{location}/securityProfileGroups/{security_profile_group}` or `projects/{project}/locations/{location}/securityProfileGroups/{security_profile_group}`.
  "threatPreventionProfile": "A String", # Optional. Reference to a `SecurityProfile` with the threat prevention configuration.
  "updateTime": "A String", # Output only. Last resource update timestamp.
  "urlFilteringProfile": "A String", # Optional. Reference to a `SecurityProfile` with the URL filtering configuration.
  "wildfireAnalysisProfile": "A String", # Optional. Reference to a `SecurityProfile` with the Advanced malware sandbox (WildFire) configuration.
}

  updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the `SecurityProfileGroup` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}

Network Security API . organizations . locations . securityProfileGroups

Instance Methods

Method Details