DataLakeDirectoryClient クラス

パッケージ:

com.azure.storage.file.datalake

Maven 成果物:

com.azure:azure-storage-file-datalake:12.18.4

• java.lang.Object
• • com.azure.storage.file.datalake.DataLakePathClient
  • • com.azure.storage.file.datalake.DataLakeDirectoryClient

public class DataLakeDirectoryClient
extends DataLakePathClient

このクラスは、Azure Storage Data Lake のディレクトリ操作を含むクライアントを提供します。 このクライアントによって提供される操作には、ディレクトリの作成、ディレクトリの削除、ディレクトリの名前変更、メタデータと http ヘッダーの設定、アクセス制御の設定と取得、プロパティの取得、ファイルとサブディレクトリの作成と削除が含まれます。

このクライアントは を介して DataLakePathClientBuilder インスタンス化されるか、 を介して getDirectoryClient(String directoryName)取得されます。

詳細については、 Azure Docs を参照してください。

メソッドの概要

修飾子と型	メソッドと説明
DataLakeFileClient	createFile(String fileName) ディレクトリ内に新しいファイルを作成します。
DataLakeFileClient	createFile(String fileName, boolean overwrite) ディレクトリ内に新しいファイルを作成します。
DataLakeFileClient	createFileIfNotExists(String fileName) ディレクトリ内に新しいファイルが存在しない場合は作成します。
Response<DataLakeFileClient>	createFileIfNotExistsWithResponse(String fileName, DataLakePathCreateOptions options, Duration timeout, Context context) ディレクトリ内に新しいファイルが存在しない場合は作成します。
Response<DataLakeFileClient>	createFileWithResponse(String fileName, DataLakePathCreateOptions options, Duration timeout, Context context) ディレクトリ内に新しいファイルを作成します。
Response<DataLakeFileClient>	createFileWithResponse(String fileName, String permissions, String umask, PathHttpHeaders headers, Map<String,String> metadata, DataLakeRequestConditions requestConditions, Duration timeout, Context context) ディレクトリ内に新しいファイルを作成します。
DataLakeDirectoryClient	createSubdirectory(String subdirectoryName) ディレクトリ内に新しいサブディレクトリを作成します。
DataLakeDirectoryClient	createSubdirectory(String subdirectoryName, boolean overwrite) ディレクトリ内に新しいサブディレクトリを作成します。
DataLakeDirectoryClient	createSubdirectoryIfNotExists(String subdirectoryName) ディレクトリ内に存在しない場合は、新しいサブディレクトリを作成します。
Response<DataLakeDirectoryClient>	createSubdirectoryIfNotExistsWithResponse(String subdirectoryName, DataLakePathCreateOptions options, Duration timeout, Context context) ディレクトリ内に新しいサブディレクトリが存在しない場合は作成します。
Response<DataLakeDirectoryClient>	createSubdirectoryWithResponse(String subdirectoryName, DataLakePathCreateOptions options, Duration timeout, Context context) ディレクトリ内に新しいサブディレクトリを作成します。
Response<DataLakeDirectoryClient>	createSubdirectoryWithResponse(String subdirectoryName, String permissions, String umask, PathHttpHeaders headers, Map<String,String> metadata, DataLakeRequestConditions requestConditions, Duration timeout, Context context) ディレクトリ内に新しいサブディレクトリを作成します。
void	delete() ディレクトリを削除します。
void	deleteFile(String fileName) ディレクトリ内の指定したファイルを削除します。
boolean	deleteFileIfExists(String fileName) ディレクトリ内の指定したファイルが存在する場合は削除します。
Response<Boolean>	deleteFileIfExistsWithResponse(String fileName, DataLakePathDeleteOptions options, Duration timeout, Context context) ディレクトリ内の指定したファイルが存在する場合は削除します。
Response<Void>	deleteFileWithResponse(String fileName, DataLakeRequestConditions requestConditions, Duration timeout, Context context) ディレクトリ内の指定したファイルを削除します。
boolean	deleteIfExists() ディレクトリが存在する場合は削除します。
Response<Boolean>	deleteIfExistsWithResponse(DataLakePathDeleteOptions options, Duration timeout, Context context) ディレクトリが存在する場合は削除します。
void	deleteRecursively() ディレクトリとディレクトリ内のすべてのコンテンツを再帰的に削除します。
Response<Void>	deleteRecursivelyWithResponse(DataLakeRequestConditions requestConditions, Duration timeout, Context context) ディレクトリとディレクトリ内のすべてのコンテンツを再帰的に削除します。
void	deleteSubdirectory(String subdirectoryName) ディレクトリ内の指定したサブディレクトリを削除します。
boolean	deleteSubdirectoryIfExists(String subdirectoryName) ディレクトリ内の指定したサブディレクトリが存在する場合は削除します。
Response<Boolean>	deleteSubdirectoryIfExistsWithResponse(String subdirectoryName, DataLakePathDeleteOptions options, Duration timeout, Context context) ディレクトリ内の指定したサブディレクトリが存在する場合は削除します。
Response<Void>	deleteSubdirectoryWithResponse(String subdirectoryName, boolean recursive, DataLakeRequestConditions requestConditions, Duration timeout, Context context) ディレクトリ内の指定したサブディレクトリを削除します。
Response<Void>	deleteWithResponse(boolean recursive, DataLakeRequestConditions requestConditions, Duration timeout, Context context) ディレクトリを削除します。
DataLakeDirectoryClient	getCustomerProvidedKeyClient(CustomerProvidedKey customerProvidedKey) 指定した DataLakeDirectoryClient を使用して、新しい customerProvidedKey を作成します。
String	getDirectoryName() 完全なパスを含まない、このディレクトリの名前を取得します。
String	getDirectoryPath() リソース自体の名前を含まない、このディレクトリのパスを取得します。
String	getDirectoryUrl() Data Lake サービス上のこのクライアントによって表されるディレクトリの URL を取得します。
DataLakeFileClient	getFileClient(String fileName) ファイル名を DataLakeDirectory クライアントの URL の末尾に連結して、新しい DataLakeFileClient オブジェクトを初期化します。
DataLakeDirectoryClient	getSubdirectoryClient(String subdirectoryName) ディレクトリ名を DataLakeDirectoryクライアントの URL の末尾に連結して、新しい DataLakeDirectoryクライアント オブジェクトを初期化します。
PagedIterable<PathItem>	listPaths() このディレクトリ内のファイル/ディレクトリの遅延読み込みリストを返します。
PagedIterable<PathItem>	listPaths(boolean recursive, boolean userPrincipleNameReturned, Integer maxResults, Duration timeout) このディレクトリ内のファイル/ディレクトリの遅延読み込みリストを返します。
DataLakeDirectoryClient	rename(String destinationFileSystem, String destinationPath) ディレクトリをファイル システム内の別の場所に移動します。
Response<DataLakeDirectoryClient>	renameWithResponse(String destinationFileSystem, String destinationPath, DataLakeRequestConditions sourceRequestConditions, DataLakeRequestConditions destinationRequestConditions, Duration timeout, Context context) ディレクトリをファイル システム内の別の場所に移動します。

メソッドの継承元: DataLakePathClient

create create createIfNotExists createIfNotExistsWithResponse createWithResponse createWithResponse deleteIfExists deleteIfExistsWithResponse exists existsWithResponse generateSas generateSas generateUserDelegationSas generateUserDelegationSas getAccessControl getAccessControlWithResponse getAccountName getCustomerProvidedKey getCustomerProvidedKeyClient getFileSystemName getHttpPipeline getProperties getPropertiesWithResponse getServiceVersion removeAccessControlRecursive removeAccessControlRecursiveWithResponse setAccessControlList setAccessControlListWithResponse setAccessControlRecursive setAccessControlRecursiveWithResponse setHttpHeaders setHttpHeadersWithResponse setMetadata setMetadataWithResponse setPermissions setPermissionsWithResponse updateAccessControlRecursive updateAccessControlRecursiveWithResponse

メソッドの継承元: java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

メソッドの詳細

createFile

public DataLakeFileClient createFile(String fileName)

ディレクトリ内に新しいファイルを作成します。 既定では、このメソッドは既存のファイルを上書きしません。 詳細については、 Azure Docs に関するページを参照してください。

コード サンプル

DataLakeFileClient fileClient = client.createFile(fileName);

Parameters:

fileName - 作成するファイルの名前。

Returns:

作成 DataLakeFileClient されたファイルの操作に使用される 。

createFile

public DataLakeFileClient createFile(String fileName, boolean overwrite)

ディレクトリ内に新しいファイルを作成します。 詳細については、 Azure Docs に関するページを参照してください。

コード サンプル

boolean overwrite = false; /* Default value. */
 DataLakeFileClient fClient = client.createFile(fileName, overwrite);

Parameters:

fileName - 作成するファイルの名前。

overwrite - ファイルが存在する必要があるかどうか。

Returns:

作成 DataLakeFileClient されたファイルの操作に使用される 。

createFileIfNotExists

public DataLakeFileClient createFileIfNotExists(String fileName)

ディレクトリ内に新しいファイルが存在しない場合は作成します。 詳細については、 Azure Docs に関するページを参照してください。

コード サンプル

DataLakeFileClient fileClient = client.createFileIfNotExists(fileName);

Parameters:

fileName - 作成するファイルの名前。

Returns:

作成 DataLakeFileClient されたファイルを操作するために使用される 。

createFileIfNotExistsWithResponse

public Response createFileIfNotExistsWithResponse(String fileName, DataLakePathCreateOptions options, Duration timeout, Context context)

ディレクトリ内に新しいファイルが存在しない場合は作成します。 詳細については、 Azure Docs に関するページを参照してください。

コード サンプル

PathHttpHeaders headers = new PathHttpHeaders().setContentLanguage("en-US").setContentType("binary");
 String permissions = "permissions";
 String umask = "umask";
 DataLakePathCreateOptions options = new DataLakePathCreateOptions()
     .setPermissions(permissions)
     .setUmask(umask)
     .setPathHttpHeaders(headers)
     .setMetadata(Collections.singletonMap("metadata", "value"));

 Response<DataLakeFileClient> response = client.createFileIfNotExistsWithResponse(fileName, options, timeout,
     new Context(key1, value1));
 if (response.getStatusCode() == 409) {
     System.out.println("Already existed.");
 } else {
     System.out.printf("Create completed with status %d%n", response.getStatusCode());
 }

Parameters:

fileName - 作成するファイルの名前。

options - DataLakePathCreateOptions メタデータ キーまたは値を削除またはエンコードする必要があります。

timeout - が発生するオプションの RuntimeException タイムアウト値。

context - サービス呼び出し中に Http パイプラインを介して渡される追加のコンテキスト。

Returns:

作成 Response<T> された value ファイルの DataLakeFileAsyncClient 操作に使用される が格納されている 。 の状態コードが 201 の場合 Response<T>、新しいファイルが正常に作成されました。 状態コードが 409 の場合、同じ名前のファイルがこの場所に既に存在します。

createFileWithResponse

public Response createFileWithResponse(String fileName, DataLakePathCreateOptions options, Duration timeout, Context context)

ディレクトリ内に新しいファイルを作成します。 同じ名前のファイルが既に存在する場合、ファイルは上書きされます。 詳細については、 Azure Docs に関するページを参照してください。

コード サンプル

PathHttpHeaders httpHeaders = new PathHttpHeaders()
     .setContentLanguage("en-US")
     .setContentType("binary");
 DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
     .setLeaseId(leaseId);
 Map<String, String> metadata = Collections.singletonMap("metadata", "value");
 String permissions = "permissions";
 String umask = "umask";
 String owner = "rwx";
 String group = "r--";
 String leaseId = UUID.randomUUID().toString();
 Integer duration = 15;
 DataLakePathCreateOptions options = new DataLakePathCreateOptions()
     .setPermissions(permissions)
     .setUmask(umask)
     .setOwner(owner)
     .setGroup(group)
     .setPathHttpHeaders(httpHeaders)
     .setRequestConditions(requestConditions)
     .setMetadata(metadata)
     .setProposedLeaseId(leaseId)
     .setLeaseDuration(duration);

 Response<DataLakeFileClient> newFileClient = client.createFileWithResponse(fileName, options, timeout,
     new Context(key1, value1));

Parameters:

fileName - 作成するファイルの名前。

options - DataLakePathCreateOptions

timeout - が発生するオプションの RuntimeException タイムアウト値。

context - サービス呼び出し中に Http パイプラインを介して渡される追加のコンテキスト。

Returns:

作成 Response<T> された value ファイルの DataLakeFileClient 操作に使用される が格納されている 。

createFileWithResponse

public Response createFileWithResponse(String fileName, String permissions, String umask, PathHttpHeaders headers, Map metadata, DataLakeRequestConditions requestConditions, Duration timeout, Context context)

ディレクトリ内に新しいファイルを作成します。 同じ名前のファイルが既に存在する場合、ファイルは上書きされます。 詳細については、 Azure Docs に関するページを参照してください。

コード サンプル

PathHttpHeaders httpHeaders = new PathHttpHeaders()
     .setContentLanguage("en-US")
     .setContentType("binary");
 DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
     .setLeaseId(leaseId);
 String permissions = "permissions";
 String umask = "umask";
 Response<DataLakeFileClient> newFileClient = client.createFileWithResponse(fileName, permissions, umask, httpHeaders,
     Collections.singletonMap("metadata", "value"), requestConditions,
     timeout, new Context(key1, value1));

Parameters:

fileName - 作成するファイルの名前。

permissions - ファイル所有者、ファイル所有グループなどの POSIX アクセス許可。

umask - 作成するファイルのアクセス許可を制限します。

headers - PathHttpHeaders

metadata - ファイルに関連付けるメタデータ。 メタデータ キーまたは値に先頭または末尾の空白がある場合は、削除またはエンコードする必要があります。

requestConditions - DataLakeRequestConditions

timeout - が発生するオプションの RuntimeException タイムアウト値。

context - サービス呼び出し中に Http パイプラインを介して渡される追加のコンテキスト。

Returns:

作成 Response<T> された value ファイルの DataLakeFileClient 操作に使用される が格納されている 。

createSubdirectory

public DataLakeDirectoryClient createSubdirectory(String subdirectoryName)

ディレクトリ内に新しいサブディレクトリを作成します。 既定では、このメソッドは既存のサブディレクトリを上書きしません。 詳細については、 Azure Docs に関するページを参照してください。

コード サンプル

DataLakeDirectoryClient directoryClient = client.createSubdirectory(directoryName);

Parameters:

subdirectoryName - 作成するサブディレクトリの名前。

Returns:

DataLakeDirectoryClient作成されたサブディレクトリを操作するために使用される 。

createSubdirectory

public DataLakeDirectoryClient createSubdirectory(String subdirectoryName, boolean overwrite)

ディレクトリ内に新しいサブディレクトリを作成します。 詳細については、 Azure Docs に関するページを参照してください。

コード サンプル

boolean overwrite = false; /* Default value. */
 DataLakeDirectoryClient dClient = client.createSubdirectory(fileName, overwrite);

Parameters:

subdirectoryName - 作成するサブディレクトリの名前。

overwrite - 上書きするかどうかに関係なく、サブディレクトリが存在する必要があります。

Returns:

DataLakeDirectoryClient作成されたサブディレクトリを操作するために使用される 。

createSubdirectoryIfNotExists

public DataLakeDirectoryClient createSubdirectoryIfNotExists(String subdirectoryName)

ディレクトリ内に存在しない場合は、新しいサブディレクトリを作成します。 詳細については、 Azure Docs に関するページを参照してください。

コード サンプル

DataLakeDirectoryClient directoryClient = client.createSubdirectoryIfNotExists(directoryName);

Parameters:

subdirectoryName - 作成するサブディレクトリの名前。

Returns:

DataLakeDirectoryClient作成されたサブディレクトリとの対話に使用される 。

createSubdirectoryIfNotExistsWithResponse

public Response createSubdirectoryIfNotExistsWithResponse(String subdirectoryName, DataLakePathCreateOptions options, Duration timeout, Context context)

ディレクトリ内に新しいサブディレクトリが存在しない場合は作成します。 詳細については、 Azure Docs に関するページを参照してください。

コード サンプル

PathHttpHeaders headers = new PathHttpHeaders()
     .setContentLanguage("en-US")
     .setContentType("binary");
 String permissions = "permissions";
 String umask = "umask";
 DataLakePathCreateOptions options = new DataLakePathCreateOptions()
     .setPermissions(permissions)
     .setUmask(umask)
     .setPathHttpHeaders(headers)
     .setMetadata(Collections.singletonMap("metadata", "value"));

 Response<DataLakeDirectoryClient> response = client.createSubdirectoryIfNotExistsWithResponse(directoryName,
     options, timeout, new Context(key1, value1));
 if (response.getStatusCode() == 409) {
     System.out.println("Already existed.");
 } else {
     System.out.printf("Create completed with status %d%n", response.getStatusCode());
 }

Parameters:

subdirectoryName - 作成するサブディレクトリの名前。

options - DataLakePathCreateOptions

timeout - が発生するオプションの RuntimeException タイムアウト値。

context - サービス呼び出し中に Http パイプラインを介して渡される追加のコンテキスト。

Returns:

作成 Response<T> された value サブディレクトリとの対話に使用される が格納 DataLakeDirectoryClient されている 。 の状態コードが 201 の場合 Response<T>、新しいサブディレクトリが正常に作成されました。 状態コードが 409 の場合、同じ名前のサブディレクトリがこの場所に既に存在します。

createSubdirectoryWithResponse

public Response createSubdirectoryWithResponse(String subdirectoryName, DataLakePathCreateOptions options, Duration timeout, Context context)

ディレクトリ内に新しいサブディレクトリを作成します。 同じ名前のサブディレクトリが既に存在する場合は、サブディレクトリが上書きされます。 詳細については、 Azure Docs に関するページを参照してください。

コード サンプル

PathHttpHeaders httpHeaders = new PathHttpHeaders()
     .setContentLanguage("en-US")
     .setContentType("binary");
 DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
     .setLeaseId(leaseId);
 Map<String, String> metadata = Collections.singletonMap("metadata", "value");
 String permissions = "permissions";
 String umask = "umask";
 String owner = "rwx";
 String group = "r--";
 String leaseId = UUID.randomUUID().toString();
 Integer duration = 15;
 DataLakePathCreateOptions options = new DataLakePathCreateOptions()
     .setPermissions(permissions)
     .setUmask(umask)
     .setOwner(owner)
     .setGroup(group)
     .setPathHttpHeaders(httpHeaders)
     .setRequestConditions(requestConditions)
     .setMetadata(metadata)
     .setProposedLeaseId(leaseId)
     .setLeaseDuration(duration);

 Response<DataLakeDirectoryClient> newDirectoryClient = client.createSubdirectoryWithResponse(directoryName,
     options, timeout, new Context(key1, value1));

Parameters:

subdirectoryName - 作成するサブディレクトリの名前。

options - DataLakePathCreateOptions

timeout - が発生するオプションの RuntimeException タイムアウト値。

context - サービス呼び出し中に Http パイプラインを介して渡される追加のコンテキスト。

Returns:

作成 Response<T> された value サブディレクトリとの対話に使用される が格納 DataLakeDirectoryClient されている 。

createSubdirectoryWithResponse

public Response createSubdirectoryWithResponse(String subdirectoryName, String permissions, String umask, PathHttpHeaders headers, Map metadata, DataLakeRequestConditions requestConditions, Duration timeout, Context context)

ディレクトリ内に新しいサブディレクトリを作成します。 同じ名前のサブディレクトリが既に存在する場合は、サブディレクトリが上書きされます。 詳細については、 Azure Docs に関するページを参照してください。

コード サンプル

PathHttpHeaders httpHeaders = new PathHttpHeaders()
     .setContentLanguage("en-US")
     .setContentType("binary");
 DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
     .setLeaseId(leaseId);
 String permissions = "permissions";
 String umask = "umask";
 Response<DataLakeDirectoryClient> newDirectoryClient = client.createSubdirectoryWithResponse(directoryName,
     permissions, umask, httpHeaders, Collections.singletonMap("metadata", "value"), requestConditions, timeout,
     new Context(key1, value1));

Parameters:

subdirectoryName - 作成するサブディレクトリの名前。

permissions - サブディレクトリ所有者、サブディレクトリ所有グループなどの POSIX アクセス許可。

umask - 作成するサブディレクトリのアクセス許可を制限します。

headers - PathHttpHeaders

metadata - リソースに関連付けるメタデータ。 メタデータ キーまたは値に先頭または末尾の空白がある場合は、削除またはエンコードする必要があります。

requestConditions - DataLakeRequestConditions

timeout - が発生するオプションの RuntimeException タイムアウト値。

context - サービス呼び出し中に Http パイプラインを介して渡される追加のコンテキスト。

Returns:

作成 Response<T> された value サブディレクトリとの対話に使用される が格納 DataLakeDirectoryClient されている 。

delete

public void delete()

ディレクトリを削除します。

コード サンプル

client.delete();
 System.out.println("Delete request completed");

詳細については、Azure Docs を参照してください。

deleteFile

public void deleteFile(String fileName)

ディレクトリ内の指定したファイルを削除します。 ファイルが存在しない場合、操作は失敗します。 詳細については、 Azure Docs を参照してください。

コード サンプル

client.deleteFile(fileName);
 System.out.println("Delete request completed");

Parameters:

fileName - 削除するファイルの名前。

deleteFileIfExists

public boolean deleteFileIfExists(String fileName)

ディレクトリ内の指定したファイルが存在する場合は削除します。 詳細については、 Azure Docs を参照してください。

コード サンプル

boolean result = client.deleteFileIfExists(fileName);
 System.out.println("Delete request completed: " + result);

Parameters:

fileName - 削除するファイルの名前。

Returns:

true ファイルが正常に削除された場合は 。 false ファイルが存在しない場合は 。

deleteFileIfExistsWithResponse

public Response deleteFileIfExistsWithResponse(String fileName, DataLakePathDeleteOptions options, Duration timeout, Context context)

ディレクトリ内の指定したファイルが存在する場合は削除します。 詳細については、 Azure Docs を参照してください。

コード サンプル

DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
     .setLeaseId(leaseId);
 DataLakePathDeleteOptions options = new DataLakePathDeleteOptions().setIsRecursive(false)
     .setRequestConditions(requestConditions);

 Response<Boolean> response = client.deleteFileIfExistsWithResponse(fileName, options, timeout,
     new Context(key1, value1));
 if (response.getStatusCode() == 404) {
     System.out.println("Does not exist.");
 } else {
     System.out.printf("Delete completed with status %d%n", response.getStatusCode());
 }

Parameters:

fileName - 削除するファイルの名前。

options - DataLakePathDeleteOptions

timeout - が発生するオプションの RuntimeException タイムアウト値。

context - サービス呼び出し中に Http パイプラインを介して渡される追加のコンテキスト。

Returns:

状態コードと HTTP ヘッダーを含む応答。 の状態コードが 200 の場合 Response<T>、指定されたファイルは正常に削除されました。 状態コードが 404 の場合、指定されたファイルは存在しません。

deleteFileWithResponse

public Response deleteFileWithResponse(String fileName, DataLakeRequestConditions requestConditions, Duration timeout, Context context)

ディレクトリ内の指定したファイルを削除します。 ファイルが存在しない場合、操作は失敗します。 詳細については、 Azure Docs を参照してください。

コード サンプル

DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
     .setLeaseId(leaseId);

 client.deleteFileWithResponse(fileName, requestConditions, timeout, new Context(key1, value1));
 System.out.println("Delete request completed");

Parameters:

fileName - 削除するファイルの名前。

requestConditions - DataLakeRequestConditions

timeout - が発生するオプションの RuntimeException タイムアウト値。

context - サービス呼び出し中に Http パイプラインを介して渡される追加のコンテキスト。

Returns:

状態コードと HTTP ヘッダーを含む応答

deleteIfExists

public boolean deleteIfExists()

ディレクトリが存在する場合は削除します。

コード サンプル

boolean result = client.deleteIfExists();
 System.out.println("Delete request completed: " + result);

詳細については、Azure Docs を参照してください。

Overrides:

DataLakeDirectoryClient.deleteIfExists()

Returns:

true ディレクトリが正常に削除された場合は 。 false ディレクトリが存在しない場合は 。

deleteIfExistsWithResponse

public Response deleteIfExistsWithResponse(DataLakePathDeleteOptions options, Duration timeout, Context context)

ディレクトリが存在する場合は削除します。

コード サンプル

DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
     .setLeaseId(leaseId);
 boolean recursive = false; // Default value
 DataLakePathDeleteOptions options = new DataLakePathDeleteOptions().setIsRecursive(recursive)
     .setRequestConditions(requestConditions);

 Response<Boolean> response = client.deleteIfExistsWithResponse(options, timeout, new Context(key1, value1));
 if (response.getStatusCode() == 404) {
     System.out.println("Does not exist.");
 } else {
     System.out.printf("Delete completed with status %d%n", response.getStatusCode());
 }

詳細については、Azure Docs を参照してください。

Overrides:

DataLakeDirectoryClient.deleteIfExistsWithResponse(DataLakePathDeleteOptions options, Duration timeout, Context context)

Parameters:

options - DataLakePathDeleteOptions

timeout - が発生するオプションの RuntimeException タイムアウト値。

context - サービス呼び出し中に Http パイプラインを介して渡される追加のコンテキスト。

Returns:

状態コードと HTTP ヘッダーを含む応答。 の状態コードが 200 の場合 Response<T>、ディレクトリは正常に削除されました。 状態コードが 404 の場合、ディレクトリは存在しません。

deleteRecursively

public void deleteRecursively()

ディレクトリとディレクトリ内のすべてのコンテンツを再帰的に削除します。

コード サンプル

client.deleteRecursively();
 System.out.println("Delete request completed");

詳細については、Azure Docs を参照してください。

deleteRecursivelyWithResponse

public Response deleteRecursivelyWithResponse(DataLakeRequestConditions requestConditions, Duration timeout, Context context)

ディレクトリとディレクトリ内のすべてのコンテンツを再帰的に削除します。

コード サンプル

DataLakeRequestConditions deleteRequestConditions = new DataLakeRequestConditions()
     .setLeaseId(leaseId);
 client.deleteRecursivelyWithResponse(deleteRequestConditions, timeout, new Context(key1, value1));
 System.out.println("Delete request completed");

詳細については、Azure Docs を参照してください。

Parameters:

requestConditions - DataLakeRequestConditions

timeout - が発生するオプションの RuntimeException タイムアウト値。

context - サービス呼び出し中に Http パイプラインを介して渡される追加のコンテキスト。

Returns:

事後対応応答シグナルの完了。

deleteSubdirectory

public void deleteSubdirectory(String subdirectoryName)

ディレクトリ内の指定したサブディレクトリを削除します。 サブディレクトリが存在しないか、空でない場合、操作は失敗します。 詳細については、 Azure Docs を参照してください。

コード サンプル

client.deleteSubdirectory(directoryName);
 System.out.println("Delete request completed");

Parameters:

subdirectoryName - 削除するサブディレクトリの名前。

deleteSubdirectoryIfExists

public boolean deleteSubdirectoryIfExists(String subdirectoryName)

ディレクトリ内の指定したサブディレクトリが存在する場合は削除します。 詳細については、 Azure Docs を参照してください。

コード サンプル

boolean result = client.deleteSubdirectoryIfExists(directoryName);
 System.out.println("Delete request completed: " + result);

Parameters:

subdirectoryName - 削除するサブディレクトリの名前。

Returns:

true サブディレクトリが正常に削除された場合は 。 false サブディレクトリが存在しない場合は 。

deleteSubdirectoryIfExistsWithResponse

public Response deleteSubdirectoryIfExistsWithResponse(String subdirectoryName, DataLakePathDeleteOptions options, Duration timeout, Context context)

ディレクトリ内の指定したサブディレクトリが存在する場合は削除します。 詳細については、 Azure Docs を参照してください。

コード サンプル

DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
     .setLeaseId(leaseId);
 boolean recursive = false; // Default value
 DataLakePathDeleteOptions options = new DataLakePathDeleteOptions().setIsRecursive(recursive)
     .setRequestConditions(requestConditions);

 Response<Boolean> response = client.deleteSubdirectoryIfExistsWithResponse(directoryName, options,
     timeout, new Context(key1, value1));
 if (response.getStatusCode() == 404) {
     System.out.println("Does not exist.");
 } else {
     System.out.printf("Delete completed with status %d%n", response.getStatusCode());
 }

Parameters:

subdirectoryName - 削除するサブディレクトリの名前。

options - DataLakePathDeleteOptions

timeout - が発生するオプションの RuntimeException タイムアウト値。

context - サービス呼び出し中に Http パイプラインを介して渡される追加のコンテキスト。

Returns:

状態コードと HTTP ヘッダーを含む応答。 の状態コードが 200 の場合 Response<T>、指定されたサブディレクトリは正常に削除されました。 状態コードが 404 の場合、指定されたサブディレクトリは存在しません。

deleteSubdirectoryWithResponse

public Response deleteSubdirectoryWithResponse(String subdirectoryName, boolean recursive, DataLakeRequestConditions requestConditions, Duration timeout, Context context)

ディレクトリ内の指定したサブディレクトリを削除します。 サブディレクトリが存在しないか、空でない場合、操作は失敗します。 詳細については、 Azure Docs を参照してください。

コード サンプル

DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
     .setLeaseId(leaseId);
 boolean recursive = false; // Default value

 client.deleteSubdirectoryWithResponse(directoryName, recursive, requestConditions, timeout,
     new Context(key1, value1));
 System.out.println("Delete request completed");

Parameters:

subdirectoryName - 削除するサブディレクトリの名前。

recursive - サブディレクトリの下にあるすべてのパスを削除するかどうか。

requestConditions - DataLakeRequestConditions

timeout - が発生するオプションの RuntimeException タイムアウト値。

context - サービス呼び出し中に Http パイプラインを介して渡される追加のコンテキスト。

Returns:

状態コードと HTTP ヘッダーを含む応答

deleteWithResponse

public Response deleteWithResponse(boolean recursive, DataLakeRequestConditions requestConditions, Duration timeout, Context context)

ディレクトリを削除します。

コード サンプル

DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
     .setLeaseId(leaseId);
 boolean recursive = false; // Default value

 client.deleteWithResponse(recursive, requestConditions, timeout, new Context(key1, value1));
 System.out.println("Delete request completed");

詳細については、Azure Docs を参照してください。

Parameters:

recursive - ディレクトリの下にあるすべてのパスを削除するかどうか。

requestConditions - DataLakeRequestConditions

timeout - が発生するオプションの RuntimeException タイムアウト値。

context - サービス呼び出し中に Http パイプラインを介して渡される追加のコンテキスト。

Returns:

事後対応応答シグナルの完了。

getCustomerProvidedKeyClient

public DataLakeDirectoryClient getCustomerProvidedKeyClient(CustomerProvidedKey customerProvidedKey)

指定した DataLakeDirectoryClient を使用して、新しい customerProvidedKey を作成します。

Overrides:

DataLakeDirectoryClient.getCustomerProvidedKeyClient(CustomerProvidedKey customerProvidedKey)

Parameters:

customerProvidedKey - CustomerProvidedKeyディレクトリの には、 を渡nullして、顧客が指定したキーを使用しません。

Returns:

指定 DataLakeDirectoryClient した customerProvidedKeyを持つ 。

getDirectoryName

public String getDirectoryName()

完全なパスを含まない、このディレクトリの名前を取得します。

Returns:

ディレクトリの名前。

getDirectoryPath

public String getDirectoryPath()

リソース自体の名前を含まない、このディレクトリのパスを取得します。

Returns:

ディレクトリのパス。

getDirectoryUrl

public String getDirectoryUrl()

Data Lake サービス上のこのクライアントによって表されるディレクトリの URL を取得します。

Returns:

URL。

getFileClient

public DataLakeFileClient getFileClient(String fileName)

FileName を DataLakeDirectoryClient の URL の末尾に連結して、新しい DataLakeFileClient オブジェクトを初期化します。 新しい DataLakeFileClient は、DataLakeDirectoryClient と同じ要求ポリシー パイプラインを使用します。

Parameters:

fileName - Stringファイルの名前を表す 。 コード サンプル

 DataLakeFileClient dataLakeFileClient = client.getFileClient(fileName);
 

Returns:

このディレクトリ内の指定した名前のファイルを参照する新しい DataLakeFileClient オブジェクト。

getSubdirectoryClient

public DataLakeDirectoryClient getSubdirectoryClient(String subdirectoryName)

dataLakeDirectoryClient の URL の末尾に directoryName を連結して、新しい DataLakeDirectoryClient オブジェクトを初期化します。 新しい DataLakeDirectoryClient は、DataLakeDirectoryClient と同じ要求ポリシー パイプラインを使用します。

Parameters:

subdirectoryName - Stringサブディレクトリの名前を表す 。 コード サンプル

 DataLakeDirectoryClient dataLakeDirectoryClient = client.getSubdirectoryClient(directoryName);
 

Returns:

このディレクトリ内の指定した名前のサブディレクトリを参照する新しい DataLakeDirectoryClient オブジェクト

listPaths

public PagedIterable listPaths()

このディレクトリ内のファイル/ディレクトリの遅延読み込みリストを返します。 返された PagedIterable<T> は、必要に応じて新しい項目が自動的に取得される間に使用できます。 詳細については、 Azure Docs に関するページを参照してください。

コード サンプル

client.listPaths().forEach(path -> System.out.printf("Name: %s%n", path.getName()));

Returns:

ファイル/ディレクトリの一覧。

listPaths

public PagedIterable listPaths(boolean recursive, boolean userPrincipleNameReturned, Integer maxResults, Duration timeout)

このディレクトリ内のファイル/ディレクトリの遅延読み込みリストを返します。 返された PagedIterable<T> は、必要に応じて新しい項目が自動的に取得される間に使用できます。 詳細については、 Azure Docs に関するページを参照してください。

コード サンプル

client.listPaths(false, false, 10, timeout)
     .forEach(path -> System.out.printf("Name: %s%n", path.getName()));

Parameters:

recursive - 呼び出しにすべてのパスを再帰的に含めるかどうかを指定します。

userPrincipleNameReturned - "true" の場合、x-ms-owner、x-ms-group、および x-ms-acl 応答ヘッダーで返されるユーザー ID 値は、Azure Active Directory オブジェクト ID からユーザー プリンシパル名に変換されます。 "false" の場合、値は Azure Active Directory オブジェクト ID として返されます。 既定値は false です。 グループ ID とアプリケーション オブジェクト ID は一意のフレンドリ名を持たないため、変換されないことに注意してください。

maxResults - すべての BlobPrefix 要素を含む、ページごとに返される BLOB の最大数を指定します。 要求で maxResults が指定されていない場合、または 5,000 を超える値を指定した場合、サーバーは 1 ページあたり最大 5,000 個のアイテムを返します。 ページごとに反復処理する場合は、 などの PagedIterable#iterableByPage(int) byPage メソッドに渡されるページ サイズがこの値よりも優先されます。

timeout - を引き RuntimeException 上げる省略可能なタイムアウト値。

Returns:

ファイル/ディレクトリの一覧。

rename

public DataLakeDirectoryClient rename(String destinationFileSystem, String destinationPath)

ディレクトリをファイル システム内の別の場所に移動します。 詳細については、 Azure Docs を参照してください。

コード サンプル

DataLakeDirectoryClient renamedClient = client.rename(fileSystemName, destinationPath);
 System.out.println("Directory Client has been renamed");

Parameters:

destinationFileSystem - アカウント内の宛先のファイル システム。 null 現在のファイル システムの場合は 。

destinationPath - ディレクトリの名前を変更するファイル システムからの相対パスは、ファイル システム名を除外します。 たとえば、fileSystem = "myfilesystem"、path = "mydir/mysubdir" を myfilesystem 内の別のパス (例: newdir) でディレクトリを移動する場合は、destinationPath = "newdir" を設定します。

Returns:

作成 DataLakeDirectoryClient された新しいディレクトリとの対話に使用される 。

renameWithResponse

public Response renameWithResponse(String destinationFileSystem, String destinationPath, DataLakeRequestConditions sourceRequestConditions, DataLakeRequestConditions destinationRequestConditions, Duration timeout, Context context)

ディレクトリをファイル システム内の別の場所に移動します。 詳細については、 Azure Docs に関するページを参照してください。

コード サンプル

DataLakeRequestConditions sourceRequestConditions = new DataLakeRequestConditions()
     .setLeaseId(leaseId);
 DataLakeRequestConditions destinationRequestConditions = new DataLakeRequestConditions();

 DataLakeDirectoryClient newRenamedClient = client.renameWithResponse(fileSystemName, destinationPath,
     sourceRequestConditions, destinationRequestConditions, timeout, new Context(key1, value1)).getValue();
 System.out.println("Directory Client has been renamed");

Parameters:

destinationFileSystem - アカウント内の宛先のファイル システム。 null 現在のファイル システムの場合は 。

destinationPath - ディレクトリの名前を変更するファイル システムからの相対パスは、ファイル システム名を除外します。 たとえば、fileSystem = "myfilesystem"、path = "mydir/mysubdir" を myfilesystem 内の別のパス (例: newdir) でディレクトリを移動する場合は、destinationPath = "newdir" を設定します。

sourceRequestConditions - DataLakeRequestConditions ソースに対して。

destinationRequestConditions - DataLakeRequestConditions を宛先に対して実行します。

timeout - を引き RuntimeException 上げる省略可能なタイムアウト値。

context - サービス呼び出し中に Http パイプラインを介して渡される追加のコンテキスト。

Returns:

Response<T>作成されたvalueディレクトリの操作に使用される をDataLakeDirectoryClient含む を持つ 。