close()

Close httplib2 connections.

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

Creates a new PostureDeployment in a given project and location.

Args:
parent: string, Required. The parent resource name, in the format `organizations/{organization}/locations/global`. (required)
body: object, The request body.
The object takes the form of:

{ # Details for a Posture deployment on an organization, folder, or project. You can deploy at most one posture to each organization, folder, or project. The parent resource for a posture deployment is always the organization, even if the deployment applies to a folder or project.
"annotations": { # Optional. The user-specified annotations for the posture deployment. For details about the values you can use in an annotation, see [AIP-148: Standard fields](https://google.aip.dev/148#annotations).
"a_key": "A String",
},
"categories": [ # Output only. The categories that the posture deployment belongs to, as determined by the Security Posture API.
"A String",
],
"createTime": "A String", # Output only. The time at which the posture deployment was created.
"description": "A String", # Optional. A description of the posture deployment.
"desiredPostureId": "A String", # Output only. The posture ID that was specified for the deployment. Present only if the posture deployment is in a failed state.
"desiredPostureRevisionId": "A String", # Output only. The revision ID of the posture that was specified for the deployment. Present only if the deployment is in a failed state.
"etag": "A String", # Optional. An opaque identifier for the current version of the posture deployment. To prevent concurrent updates from overwriting each other, always provide the `etag` when you update a posture deployment. You can also provide the `etag` when you delete a posture deployment, to help ensure that you're deleting the intended posture deployment.
"failureMessage": "A String", # Output only. A description of why the posture deployment failed. Present only if the deployment is in a failed state.
"name": "A String", # Required. Identifier. The name of the posture deployment, in the format `organizations/{organization}/locations/global/postureDeployments/{deployment_id}`.
"postureId": "A String", # Required. The posture used in the deployment, in the format `organizations/{organization}/locations/global/postures/{posture_id}`.
"postureRevisionId": "A String", # Required. The revision ID of the posture used in the deployment.
"reconciling": True or False, # Output only. Whether the posture deployment is in the process of being updated.
"state": "A String", # Output only. The state of the posture deployment.
"targetResource": "A String", # Required. The organization, folder, or project where the posture is deployed. Uses one of the following formats: * `organizations/{organization_number}` * `folders/{folder_number}` * `projects/{project_number}`
"updateTime": "A String", # Output only. The time at which the posture deployment was last updated.
}

postureDeploymentId: string, Required. An identifier for the posture deployment.
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 PostureDeployment.

Args:
name: string, Required. The name of the posture deployment, in the format `organizations/{organization}/locations/global/postureDeployments/{posture_id}`. (required)
etag: string, Optional. An opaque identifier for the current version of the posture deployment. If you provide this value, then it must match the existing value. If the values don't match, then the request fails with an ABORTED error. If you omit this value, then the posture deployment is deleted regardless of its current `etag` value.
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 for a PostureDeployment.

Args:
  name: string, Required. The name of the PostureDeployment, in the format `organizations/{organization}/locations/global/postureDeployments/{posture_deployment_id}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Details for a Posture deployment on an organization, folder, or project. You can deploy at most one posture to each organization, folder, or project. The parent resource for a posture deployment is always the organization, even if the deployment applies to a folder or project.
  "annotations": { # Optional. The user-specified annotations for the posture deployment. For details about the values you can use in an annotation, see [AIP-148: Standard fields](https://google.aip.dev/148#annotations).
    "a_key": "A String",
  },
  "categories": [ # Output only. The categories that the posture deployment belongs to, as determined by the Security Posture API.
    "A String",
  ],
  "createTime": "A String", # Output only. The time at which the posture deployment was created.
  "description": "A String", # Optional. A description of the posture deployment.
  "desiredPostureId": "A String", # Output only. The posture ID that was specified for the deployment. Present only if the posture deployment is in a failed state.
  "desiredPostureRevisionId": "A String", # Output only. The revision ID of the posture that was specified for the deployment. Present only if the deployment is in a failed state.
  "etag": "A String", # Optional. An opaque identifier for the current version of the posture deployment. To prevent concurrent updates from overwriting each other, always provide the `etag` when you update a posture deployment. You can also provide the `etag` when you delete a posture deployment, to help ensure that you're deleting the intended posture deployment.
  "failureMessage": "A String", # Output only. A description of why the posture deployment failed. Present only if the deployment is in a failed state.
  "name": "A String", # Required. Identifier. The name of the posture deployment, in the format `organizations/{organization}/locations/global/postureDeployments/{deployment_id}`.
  "postureId": "A String", # Required. The posture used in the deployment, in the format `organizations/{organization}/locations/global/postures/{posture_id}`.
  "postureRevisionId": "A String", # Required. The revision ID of the posture used in the deployment.
  "reconciling": True or False, # Output only. Whether the posture deployment is in the process of being updated.
  "state": "A String", # Output only. The state of the posture deployment.
  "targetResource": "A String", # Required. The organization, folder, or project where the posture is deployed. Uses one of the following formats: * `organizations/{organization_number}` * `folders/{folder_number}` * `projects/{project_number}`
  "updateTime": "A String", # Output only. The time at which the posture deployment was last updated.
}

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

Lists every PostureDeployment in a project and location.

Args:
  parent: string, Required. The parent resource name, in the format `organizations/{organization}/locations/global`. (required)
  filter: string, Optional. A filter to apply to the list of postures, in the format defined in [AIP-160: Filtering](https://google.aip.dev/160).
  pageSize: integer, Optional. The maximum number of posture deployments to return. The default value is `500`. If you exceed the maximum value of `1000`, then the service uses the maximum value.
  pageToken: string, Optional. A pagination token returned from a previous request to list posture deployments. Provide this token to retrieve the next page of results.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for ListPostureDeployments.
  "nextPageToken": "A String", # A pagination token. To retrieve the next page of results, call the method again with this token.
  "postureDeployments": [ # The list of PostureDeployment resources.
    { # Details for a Posture deployment on an organization, folder, or project. You can deploy at most one posture to each organization, folder, or project. The parent resource for a posture deployment is always the organization, even if the deployment applies to a folder or project.
      "annotations": { # Optional. The user-specified annotations for the posture deployment. For details about the values you can use in an annotation, see [AIP-148: Standard fields](https://google.aip.dev/148#annotations).
        "a_key": "A String",
      },
      "categories": [ # Output only. The categories that the posture deployment belongs to, as determined by the Security Posture API.
        "A String",
      ],
      "createTime": "A String", # Output only. The time at which the posture deployment was created.
      "description": "A String", # Optional. A description of the posture deployment.
      "desiredPostureId": "A String", # Output only. The posture ID that was specified for the deployment. Present only if the posture deployment is in a failed state.
      "desiredPostureRevisionId": "A String", # Output only. The revision ID of the posture that was specified for the deployment. Present only if the deployment is in a failed state.
      "etag": "A String", # Optional. An opaque identifier for the current version of the posture deployment. To prevent concurrent updates from overwriting each other, always provide the `etag` when you update a posture deployment. You can also provide the `etag` when you delete a posture deployment, to help ensure that you're deleting the intended posture deployment.
      "failureMessage": "A String", # Output only. A description of why the posture deployment failed. Present only if the deployment is in a failed state.
      "name": "A String", # Required. Identifier. The name of the posture deployment, in the format `organizations/{organization}/locations/global/postureDeployments/{deployment_id}`.
      "postureId": "A String", # Required. The posture used in the deployment, in the format `organizations/{organization}/locations/global/postures/{posture_id}`.
      "postureRevisionId": "A String", # Required. The revision ID of the posture used in the deployment.
      "reconciling": True or False, # Output only. Whether the posture deployment is in the process of being updated.
      "state": "A String", # Output only. The state of the posture deployment.
      "targetResource": "A String", # Required. The organization, folder, or project where the posture is deployed. Uses one of the following formats: * `organizations/{organization_number}` * `folders/{folder_number}` * `projects/{project_number}`
      "updateTime": "A String", # Output only. The time at which the posture deployment was last updated.
    },
  ],
  "unreachable": [ # Locations that were temporarily unavailable and could not be reached.
    "A String",
  ],
}

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)

Updates an existing PostureDeployment. To prevent concurrent updates from overwriting each other, always follow the read-modify-write pattern when you update a posture deployment: 1. Call GetPostureDeployment to get the current version of the deployment. 2. Update the fields in the deployment as needed. 3. Call UpdatePostureDeployment to update the deployment. Ensure that your request includes the `etag` value from the GetPostureDeployment response. **Important:** If you omit the `etag` when you call UpdatePostureDeployment, then the updated deployment unconditionally overwrites the existing deployment.

Args:
name: string, Required. Identifier. The name of the posture deployment, in the format `organizations/{organization}/locations/global/postureDeployments/{deployment_id}`. (required)
body: object, The request body.
The object takes the form of:

{ # Details for a Posture deployment on an organization, folder, or project. You can deploy at most one posture to each organization, folder, or project. The parent resource for a posture deployment is always the organization, even if the deployment applies to a folder or project.
"annotations": { # Optional. The user-specified annotations for the posture deployment. For details about the values you can use in an annotation, see [AIP-148: Standard fields](https://google.aip.dev/148#annotations).
"a_key": "A String",
},
"categories": [ # Output only. The categories that the posture deployment belongs to, as determined by the Security Posture API.
"A String",
],
"createTime": "A String", # Output only. The time at which the posture deployment was created.
"description": "A String", # Optional. A description of the posture deployment.
"desiredPostureId": "A String", # Output only. The posture ID that was specified for the deployment. Present only if the posture deployment is in a failed state.
"desiredPostureRevisionId": "A String", # Output only. The revision ID of the posture that was specified for the deployment. Present only if the deployment is in a failed state.
"etag": "A String", # Optional. An opaque identifier for the current version of the posture deployment. To prevent concurrent updates from overwriting each other, always provide the `etag` when you update a posture deployment. You can also provide the `etag` when you delete a posture deployment, to help ensure that you're deleting the intended posture deployment.
"failureMessage": "A String", # Output only. A description of why the posture deployment failed. Present only if the deployment is in a failed state.
"name": "A String", # Required. Identifier. The name of the posture deployment, in the format `organizations/{organization}/locations/global/postureDeployments/{deployment_id}`.
"postureId": "A String", # Required. The posture used in the deployment, in the format `organizations/{organization}/locations/global/postures/{posture_id}`.
"postureRevisionId": "A String", # Required. The revision ID of the posture used in the deployment.
"reconciling": True or False, # Output only. Whether the posture deployment is in the process of being updated.
"state": "A String", # Output only. The state of the posture deployment.
"targetResource": "A String", # Required. The organization, folder, or project where the posture is deployed. Uses one of the following formats: * `organizations/{organization_number}` * `folders/{folder_number}` * `projects/{project_number}`
"updateTime": "A String", # Output only. The time at which the posture deployment was last updated.
}

updateMask: string, Required. The fields in the PostureDeployment to update. You can update only the following fields: * PostureDeployment.posture_id * PostureDeployment.posture_revision_id
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.
},
}

Security Posture API . organizations . locations . postureDeployments

Instance Methods

Method Details