# NetApp API . projects . locations . backupPolicies

## Instance Methods

Close httplib2 connections.

Creates new backup policy

Warning! This operation will permanently delete the backup policy.

Returns the description of the specified backup policy by backup_policy_id.

Returns list of all available backup policies.

Retrieves the next page of results.

Updates settings of a specific backup policy.

### Method Details

`close()`

    Close httplib2 connections.

`create(parent, backupPolicyId=None, body=None, x__xgafv=None)`

    Creates new backup policy

    Args:
      parent: string, Required. The location to create the backup policies of, in the format `projects/{project_id}/locations/{location}` (required)
      body: object, The request body.
        The object takes the form of:

    { # Backup Policy.
      "assignedVolumeCount": 42, # Output only. The total number of volumes assigned by this backup policy.
      "createTime": "A String", # Output only. The time when the backup policy was created.
      "dailyBackupLimit": 42, # Number of daily backups to keep. Note that the minimum daily backup limit is 2.
      "description": "A String", # Description of the backup policy.
      "enabled": True or False, # If enabled, make backups automatically according to the schedules. This will be applied to all volumes that have this policy attached and enforced on volume level. If not specified, default is true.
      "labels": { # Resource labels to represent user provided metadata.
        "a_key": "A String",
      },
      "monthlyBackupLimit": 42, # Number of monthly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.
      "name": "A String", # Identifier. The resource name of the backup policy. Format: `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`.
      "state": "A String", # Output only. The backup policy state.
      "weeklyBackupLimit": 42, # Number of weekly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.
    }

      backupPolicyId: string, Required. The ID to use for the backup policy. The ID must be unique within the specified location. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.
      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, x__xgafv=None)`

    Warning! This operation will permanently delete the backup policy.

    Args:
      name: string, Required. The backup policy resource name, in the format `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}` (required)
      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)`

    Returns the description of the specified backup policy by backup_policy_id.

    Args:
      name: string, Required. The backupPolicy resource name, in the format `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}` (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Backup Policy.
      "assignedVolumeCount": 42, # Output only. The total number of volumes assigned by this backup policy.
      "createTime": "A String", # Output only. The time when the backup policy was created.
      "dailyBackupLimit": 42, # Number of daily backups to keep. Note that the minimum daily backup limit is 2.
      "description": "A String", # Description of the backup policy.
      "enabled": True or False, # If enabled, make backups automatically according to the schedules. This will be applied to all volumes that have this policy attached and enforced on volume level. If not specified, default is true.
      "labels": { # Resource labels to represent user provided metadata.
        "a_key": "A String",
      },
      "monthlyBackupLimit": 42, # Number of monthly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.
      "name": "A String", # Identifier. The resource name of the backup policy. Format: `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`.
      "state": "A String", # Output only. The backup policy state.
      "weeklyBackupLimit": 42, # Number of weekly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.
    }

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

    Returns list of all available backup policies.

    Args:
      parent: string, Required. Parent value for ListBackupPoliciesRequest (required)
      filter: string, Filtering results
      orderBy: string, Hint for how to order the results
      pageSize: integer, Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
      pageToken: string, A token identifying a page of results the server should return.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # ListBackupPoliciesResponse contains all the backup policies requested.
      "backupPolicies": [ # The list of backup policies.
        { # Backup Policy.
          "assignedVolumeCount": 42, # Output only. The total number of volumes assigned by this backup policy.
          "createTime": "A String", # Output only. The time when the backup policy was created.
          "dailyBackupLimit": 42, # Number of daily backups to keep. Note that the minimum daily backup limit is 2.
          "description": "A String", # Description of the backup policy.
          "enabled": True or False, # If enabled, make backups automatically according to the schedules. This will be applied to all volumes that have this policy attached and enforced on volume level. If not specified, default is true.
          "labels": { # Resource labels to represent user provided metadata.
            "a_key": "A String",
          },
          "monthlyBackupLimit": 42, # Number of monthly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.
          "name": "A String", # Identifier. The resource name of the backup policy. Format: `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`.
          "state": "A String", # Output only. The backup policy state.
          "weeklyBackupLimit": 42, # Number of weekly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.
        },
      ],
      "nextPageToken": "A String", # A token identifying a page of results the server should return.
      "unreachable": [ # Locations that 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 settings of a specific backup policy.

    Args:
      name: string, Identifier. The resource name of the backup policy. Format: `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`. (required)
      body: object, The request body.
        The object takes the form of:

    { # Backup Policy.
      "assignedVolumeCount": 42, # Output only. The total number of volumes assigned by this backup policy.
      "createTime": "A String", # Output only. The time when the backup policy was created.
      "dailyBackupLimit": 42, # Number of daily backups to keep. Note that the minimum daily backup limit is 2.
      "description": "A String", # Description of the backup policy.
      "enabled": True or False, # If enabled, make backups automatically according to the schedules. This will be applied to all volumes that have this policy attached and enforced on volume level. If not specified, default is true.
      "labels": { # Resource labels to represent user provided metadata.
        "a_key": "A String",
      },
      "monthlyBackupLimit": 42, # Number of monthly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.
      "name": "A String", # Identifier. The resource name of the backup policy. Format: `projects/{project_id}/locations/{location}/backupPolicies/{backup_policy_id}`.
      "state": "A String", # Output only. The backup policy state.
      "weeklyBackupLimit": 42, # Number of weekly backups to keep. Note that the sum of daily, weekly and monthly backups should be greater than 1.
    }

      updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Backup Policy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
      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.
      },
    }