close()

Close httplib2 connections.

create(parent, body=None, requestId=None, userId=None, x__xgafv=None)

Creates a new User in a given project and location and Server.

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

{ # Message describing User object
"createTime": "A String", # Output only. [Output only] Create time stamp
"customerServiceAccount": "A String", # Required. Service account in customer project attached to this SFTP User.
"labels": { # Optional. Labels as key value pairs
"a_key": "A String",
},
"name": "A String", # Identifier. User-friendly name via which User will be identified. projects/{project}/locations/{location}/servers/{server}/users/{user}
"state": "A String", # Output only. Tracks user creation.
"storageDirectoryMappings": [ # Required. Mapping of Cloud Storage buckets to directories where the user will land in the SFTP server.
{ # Mapping of backing Cloud Storage path to the directory where the user lands in the SFTP server. If directory is not specified, it'll default to '/'. Eg 1 - (bucket_name: bucket, bucket_prefix: path1/path2, directory: /abc/def/username) The user will land at /abcd/def/username, and the view there will match that of /bucket/path1/path2. The user will not be aware of Cloud Storage prefix '/bucket/path1' and there will be no such directory in the view. Eg 2 - (bucket_name: bucket, bucket_prefix: path1/path2, directory: '') The user will land at '/', and the view there will match that of /bucket/path1/path2. The user will not be aware of Cloud Storage prefix '/bucket/path1/path2' and there will be no such directory in the view.
"bucket": "A String", # Required. Name of the bucket.
"bucketPrefix": "A String", # Optional. Prefix inside the bucket.
"directory": "A String", # Required. Directory where the user lands in the SFTP server.
"permission": "A String", # Required. Permission to the bucket.
},
],
"updateTime": "A String", # Output only. [Output only] Update time stamp
"userCredentials": [ # Required. User credential for the user. The maximum number of user credentials is 10.
{ # Message describing UserCredential object
"credentialName": "A String", # Required. Name of the user credential.
"credentialType": "A String", # Required. Type of credential.
"sshPublicKeyBody": "A String", # Optional. SSH public key body in OpenSSH format. Example: "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ..."
},
],
"username": "A String", # Output only. [Output only] The username of the user.
}

requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
userId: string, Required. A unique user ID for the SFTP user. The user ID must start with a lowercase letter and can include lowercase letters, numbers, or hyphens.
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, force=None, x__xgafv=None)

Deletes a single User.

Args:
name: string, Required. Name of the resource (required)
force: boolean, Optional. If set to true, the request will force the deletion of the User.
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, view=None, x__xgafv=None)

Gets details of a single User.

Args:
  name: string, Required. Name of the resource (required)
  view: string, Optional. The view of the User resource to return.
    Allowed values
      USER_VIEW_UNSPECIFIED - Default value. Equivalent to USER_VIEW_BASIC.
      USER_VIEW_BASIC - Basic view. Excludes heavy configurations (user_credentials, storage_directory_mappings).
      USER_VIEW_FULL - Full view. Includes all fields.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message describing User object
  "createTime": "A String", # Output only. [Output only] Create time stamp
  "customerServiceAccount": "A String", # Required. Service account in customer project attached to this SFTP User.
  "labels": { # Optional. Labels as key value pairs
    "a_key": "A String",
  },
  "name": "A String", # Identifier. User-friendly name via which User will be identified. projects/{project}/locations/{location}/servers/{server}/users/{user}
  "state": "A String", # Output only. Tracks user creation.
  "storageDirectoryMappings": [ # Required. Mapping of Cloud Storage buckets to directories where the user will land in the SFTP server.
    { # Mapping of backing Cloud Storage path to the directory where the user lands in the SFTP server. If directory is not specified, it'll default to '/'. Eg 1 - (bucket_name: bucket, bucket_prefix: path1/path2, directory: /abc/def/username) The user will land at /abcd/def/username, and the view there will match that of /bucket/path1/path2. The user will not be aware of Cloud Storage prefix '/bucket/path1' and there will be no such directory in the view. Eg 2 - (bucket_name: bucket, bucket_prefix: path1/path2, directory: '') The user will land at '/', and the view there will match that of /bucket/path1/path2. The user will not be aware of Cloud Storage prefix '/bucket/path1/path2' and there will be no such directory in the view.
      "bucket": "A String", # Required. Name of the bucket.
      "bucketPrefix": "A String", # Optional. Prefix inside the bucket.
      "directory": "A String", # Required. Directory where the user lands in the SFTP server.
      "permission": "A String", # Required. Permission to the bucket.
    },
  ],
  "updateTime": "A String", # Output only. [Output only] Update time stamp
  "userCredentials": [ # Required. User credential for the user. The maximum number of user credentials is 10.
    { # Message describing UserCredential object
      "credentialName": "A String", # Required. Name of the user credential.
      "credentialType": "A String", # Required. Type of credential.
      "sshPublicKeyBody": "A String", # Optional. SSH public key body in OpenSSH format. Example: "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ..."
    },
  ],
  "username": "A String", # Output only. [Output only] The username of the user.
}

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

Lists Users in a given project and location.

Args:
  parent: string, Required. Parent value for ListUsersRequest (required)
  filter: string, Optional. Filtering results
  orderBy: string, Optional. Hint for how to order the results
  pageSize: integer, Optional. Requested page size. User may return fewer items than requested. The maximum value is 1000; The default value is 50 if the field is omitted (or set to 0).
  pageToken: string, Optional. A token identifying a page of results the user should return.
  view: string, Optional. The view of the User resource to return.
    Allowed values
      USER_VIEW_UNSPECIFIED - Default value. Equivalent to USER_VIEW_BASIC.
      USER_VIEW_BASIC - Basic view. Excludes heavy configurations (user_credentials, storage_directory_mappings).
      USER_VIEW_FULL - Full view. Includes all fields.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Message for response to listing Users
  "nextPageToken": "A String", # A token identifying a page of results the user should return.
  "unreachable": [ # Unordered list. Locations that could not be reached.
    "A String",
  ],
  "users": [ # The list of User
    { # Message describing User object
      "createTime": "A String", # Output only. [Output only] Create time stamp
      "customerServiceAccount": "A String", # Required. Service account in customer project attached to this SFTP User.
      "labels": { # Optional. Labels as key value pairs
        "a_key": "A String",
      },
      "name": "A String", # Identifier. User-friendly name via which User will be identified. projects/{project}/locations/{location}/servers/{server}/users/{user}
      "state": "A String", # Output only. Tracks user creation.
      "storageDirectoryMappings": [ # Required. Mapping of Cloud Storage buckets to directories where the user will land in the SFTP server.
        { # Mapping of backing Cloud Storage path to the directory where the user lands in the SFTP server. If directory is not specified, it'll default to '/'. Eg 1 - (bucket_name: bucket, bucket_prefix: path1/path2, directory: /abc/def/username) The user will land at /abcd/def/username, and the view there will match that of /bucket/path1/path2. The user will not be aware of Cloud Storage prefix '/bucket/path1' and there will be no such directory in the view. Eg 2 - (bucket_name: bucket, bucket_prefix: path1/path2, directory: '') The user will land at '/', and the view there will match that of /bucket/path1/path2. The user will not be aware of Cloud Storage prefix '/bucket/path1/path2' and there will be no such directory in the view.
          "bucket": "A String", # Required. Name of the bucket.
          "bucketPrefix": "A String", # Optional. Prefix inside the bucket.
          "directory": "A String", # Required. Directory where the user lands in the SFTP server.
          "permission": "A String", # Required. Permission to the bucket.
        },
      ],
      "updateTime": "A String", # Output only. [Output only] Update time stamp
      "userCredentials": [ # Required. User credential for the user. The maximum number of user credentials is 10.
        { # Message describing UserCredential object
          "credentialName": "A String", # Required. Name of the user credential.
          "credentialType": "A String", # Required. Type of credential.
          "sshPublicKeyBody": "A String", # Optional. SSH public key body in OpenSSH format. Example: "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ..."
        },
      ],
      "username": "A String", # Output only. [Output only] The username of the user.
    },
  ],
}

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 the parameters of a single User.

Args:
name: string, Identifier. User-friendly name via which User will be identified. projects/{project}/locations/{location}/servers/{server}/users/{user} (required)
body: object, The request body.
The object takes the form of:

{ # Message describing User object
"createTime": "A String", # Output only. [Output only] Create time stamp
"customerServiceAccount": "A String", # Required. Service account in customer project attached to this SFTP User.
"labels": { # Optional. Labels as key value pairs
"a_key": "A String",
},
"name": "A String", # Identifier. User-friendly name via which User will be identified. projects/{project}/locations/{location}/servers/{server}/users/{user}
"state": "A String", # Output only. Tracks user creation.
"storageDirectoryMappings": [ # Required. Mapping of Cloud Storage buckets to directories where the user will land in the SFTP server.
{ # Mapping of backing Cloud Storage path to the directory where the user lands in the SFTP server. If directory is not specified, it'll default to '/'. Eg 1 - (bucket_name: bucket, bucket_prefix: path1/path2, directory: /abc/def/username) The user will land at /abcd/def/username, and the view there will match that of /bucket/path1/path2. The user will not be aware of Cloud Storage prefix '/bucket/path1' and there will be no such directory in the view. Eg 2 - (bucket_name: bucket, bucket_prefix: path1/path2, directory: '') The user will land at '/', and the view there will match that of /bucket/path1/path2. The user will not be aware of Cloud Storage prefix '/bucket/path1/path2' and there will be no such directory in the view.
"bucket": "A String", # Required. Name of the bucket.
"bucketPrefix": "A String", # Optional. Prefix inside the bucket.
"directory": "A String", # Required. Directory where the user lands in the SFTP server.
"permission": "A String", # Required. Permission to the bucket.
},
],
"updateTime": "A String", # Output only. [Output only] Update time stamp
"userCredentials": [ # Required. User credential for the user. The maximum number of user credentials is 10.
{ # Message describing UserCredential object
"credentialName": "A String", # Required. Name of the user credential.
"credentialType": "A String", # Required. Type of credential.
"sshPublicKeyBody": "A String", # Optional. SSH public key body in OpenSSH format. Example: "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQ..."
},
],
"username": "A String", # Output only. [Output only] The username of the user.
}

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

Cloud FTP API . projects . locations . servers . users

Instance Methods

Method Details