NetApp API . projects . locations . volumes . quotaRules

Instance Methods

close()

Close httplib2 connections.

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

Creates a new quota rule.

delete(name, x__xgafv=None)

Deletes a quota rule.

get(name, x__xgafv=None)

Returns details of the specified quota rule.

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

Returns list of all quota rules in a location.

list_next()

Retrieves the next page of results.

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

Updates a quota rule.

Method Details

close()
Close httplib2 connections.
create(parent, body=None, quotaRuleId=None, x__xgafv=None)
Creates a new quota rule.

Args:
  parent: string, Required. Parent value for CreateQuotaRuleRequest (required)
  body: object, The request body.
    The object takes the form of:

{ # QuotaRule specifies the maximum disk space a user or group can use within a volume. They can be used for creating default and individual quota rules.
  "createTime": "A String", # Output only. Create time of the quota rule
  "description": "A String", # Optional. Description of the quota rule
  "diskLimitMib": 42, # Required. The maximum allowed disk space in MiB.
  "labels": { # Optional. Labels of the quota rule
    "a_key": "A String",
  },
  "name": "A String", # Identifier. The resource name of the active directory. Format: `projects/{project_number}/locations/{location_id}/quotaRules/{quota_rule_id}`.
  "state": "A String", # Output only. State of the quota rule
  "stateDetails": "A String", # Output only. State details of the quota rule
  "target": "A String", # Optional. The quota rule applies to the specified user or group, identified by a Unix UID/GID, Windows SID, or null for default.
  "type": "A String", # Required. The type of quota rule.
}

  quotaRuleId: string, Required. ID of the quota rule to create. Must be unique within the parent resource. Must contain only letters, numbers, underscore and hyphen, with the first character a letter or underscore, the last a letter or underscore 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)
Deletes a quota rule.

Args:
  name: string, Required. Name of the quota rule. (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 details of the specified quota rule.

Args:
  name: string, Required. Name of the quota rule (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # QuotaRule specifies the maximum disk space a user or group can use within a volume. They can be used for creating default and individual quota rules.
  "createTime": "A String", # Output only. Create time of the quota rule
  "description": "A String", # Optional. Description of the quota rule
  "diskLimitMib": 42, # Required. The maximum allowed disk space in MiB.
  "labels": { # Optional. Labels of the quota rule
    "a_key": "A String",
  },
  "name": "A String", # Identifier. The resource name of the active directory. Format: `projects/{project_number}/locations/{location_id}/quotaRules/{quota_rule_id}`.
  "state": "A String", # Output only. State of the quota rule
  "stateDetails": "A String", # Output only. State details of the quota rule
  "target": "A String", # Optional. The quota rule applies to the specified user or group, identified by a Unix UID/GID, Windows SID, or null for default.
  "type": "A String", # Required. The type of quota rule.
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Returns list of all quota rules in a location.

Args:
  parent: string, Required. Parent value for ListQuotaRulesRequest (required)
  filter: string, Optional. Filtering results
  orderBy: string, Optional. Hint for how to order the results
  pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
  pageToken: string, Optional. 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:

    { # ListQuotaRulesResponse is the response to a ListQuotaRulesRequest.
  "nextPageToken": "A String", # A token identifying a page of results the server should return.
  "quotaRules": [ # List of quota rules
    { # QuotaRule specifies the maximum disk space a user or group can use within a volume. They can be used for creating default and individual quota rules.
      "createTime": "A String", # Output only. Create time of the quota rule
      "description": "A String", # Optional. Description of the quota rule
      "diskLimitMib": 42, # Required. The maximum allowed disk space in MiB.
      "labels": { # Optional. Labels of the quota rule
        "a_key": "A String",
      },
      "name": "A String", # Identifier. The resource name of the active directory. Format: `projects/{project_number}/locations/{location_id}/quotaRules/{quota_rule_id}`.
      "state": "A String", # Output only. State of the quota rule
      "stateDetails": "A String", # Output only. State details of the quota rule
      "target": "A String", # Optional. The quota rule applies to the specified user or group, identified by a Unix UID/GID, Windows SID, or null for default.
      "type": "A String", # Required. The type of quota rule.
    },
  ],
  "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 a quota rule.

Args:
  name: string, Identifier. The resource name of the active directory. Format: `projects/{project_number}/locations/{location_id}/quotaRules/{quota_rule_id}`. (required)
  body: object, The request body.
    The object takes the form of:

{ # QuotaRule specifies the maximum disk space a user or group can use within a volume. They can be used for creating default and individual quota rules.
  "createTime": "A String", # Output only. Create time of the quota rule
  "description": "A String", # Optional. Description of the quota rule
  "diskLimitMib": 42, # Required. The maximum allowed disk space in MiB.
  "labels": { # Optional. Labels of the quota rule
    "a_key": "A String",
  },
  "name": "A String", # Identifier. The resource name of the active directory. Format: `projects/{project_number}/locations/{location_id}/quotaRules/{quota_rule_id}`.
  "state": "A String", # Output only. State of the quota rule
  "stateDetails": "A String", # Output only. State details of the quota rule
  "target": "A String", # Optional. The quota rule applies to the specified user or group, identified by a Unix UID/GID, Windows SID, or null for default.
  "type": "A String", # Required. The type of quota rule.
}

  updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the Quota Rule 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.
  },
}