DataLakeDirectoryAsyncClient クラス
- java.
lang. Object - com.
azure. storage. file. datalake. DataLakePathAsyncClient - com.
azure. storage. file. datalake. DataLakeDirectoryAsyncClient
- com.
- com.
public final class DataLakeDirectoryAsyncClient
extends DataLakePathAsyncClient
このクラスは、Azure Storage Data Lake のディレクトリ操作を含むクライアントを提供します。 このクライアントによって提供される操作には、ディレクトリの作成、ディレクトリの削除、ディレクトリの名前変更、メタデータと http ヘッダーの設定、アクセス制御の設定と取得、プロパティの取得、ファイルとサブディレクトリの作成と削除が含まれます。
このクライアントは を介して DataLakePathClientBuilder インスタンス化されるか、 を介して getDirectoryAsyncClient(String directoryName)取得されます。
詳細については、 Azure Docs を参照してください。
メソッドの概要
メソッドの継承元: DataLakePathAsyncClient
メソッドの継承元: java.lang.Object
メソッドの詳細
createFile
public Mono
ディレクトリ内に新しいファイルを作成します。 既定では、このメソッドは既存のファイルを上書きしません。 詳細については、 Azure Docs に関するページを参照してください。
コード サンプル
DataLakeFileAsyncClient fileClient = client.createFile(fileName).block();
Parameters:
Returns:
createFile
public Mono
ディレクトリ内に新しいファイルを作成します。 詳細については、 Azure Docs に関するページを参照してください。
コード サンプル
boolean overwrite = false; /* Default value. */
DataLakeFileAsyncClient fClient = client.createFile(fileName, overwrite).block();
Parameters:
Returns:
createFileIfNotExists
public Mono
ディレクトリ内に新しいファイルが存在しない場合は作成します。 既定では、このメソッドは既存のファイルを上書きしません。 詳細については、 Azure Docs に関するページを参照してください。
コード サンプル
DataLakeFileAsyncClient fileClient = client.createFileIfNotExists(fileName).block();
Parameters:
Returns:
createFileIfNotExistsWithResponse
public Mono
ディレクトリ内に新しいファイルが存在しない場合は作成します。 詳細については、 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"));
client.createFileIfNotExistsWithResponse(fileName, options).subscribe(response -> {
if (response.getStatusCode() == 409) {
System.out.println("Already exists.");
} else {
System.out.println("successfully created.");
}
});
Parameters:
Returns:
createFileWithResponse
public Mono
ディレクトリ内に新しいファイルを作成します。 同じ名前のファイルが既に存在する場合、ファイルは上書きされます。 詳細については、 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 = CoreUtils.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);
DataLakeFileAsyncClient newFileClient = client.createFileWithResponse(fileName, options).block().getValue();
Parameters:
Returns:
createFileWithResponse
public Mono
ディレクトリ内に新しいファイルを作成します。 同じ名前のファイルが既に存在する場合、ファイルは上書きされます。 詳細については、 Azure Docs に関するページを参照してください。
コード サンプル
PathHttpHeaders httpHeaders = new PathHttpHeaders()
.setContentLanguage("en-US")
.setContentType("binary");
DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
.setLeaseId(leaseId);
String permissions = "permissions";
String umask = "umask";
DataLakeFileAsyncClient newFileClient = client.createFileWithResponse(fileName,
permissions, umask, httpHeaders, Collections.singletonMap("metadata", "value"), requestConditions
).block().getValue();
Parameters:
Returns:
createSubdirectory
public Mono
ディレクトリ内に新しいサブディレクトリを作成します。 既定では、このメソッドは既存のサブディレクトリを上書きしません。 詳細については、 Azure Docs に関するページを参照してください。
コード サンプル
DataLakeDirectoryAsyncClient directoryClient = client.createSubdirectory(directoryName).block();
Parameters:
Returns:
createSubdirectory
public Mono
ディレクトリ内に新しいサブディレクトリを作成します。 詳細については、 Azure Docs に関するページを参照してください。
コード サンプル
boolean overwrite = false; /* Default value. */
DataLakeDirectoryAsyncClient dClient = client.createSubdirectory(directoryName, overwrite).block();
Parameters:
Returns:
createSubdirectoryIfNotExists
public Mono
ディレクトリ内に新しいサブディレクトリが存在しない場合は作成します。 詳細については、 Azure Docs に関するページを参照してください。
コード サンプル
DataLakeDirectoryAsyncClient subdirectoryClient = client.createSubdirectoryIfNotExists(directoryName).block();
Parameters:
Returns:
createSubdirectoryIfNotExistsWithResponse
public Mono
ディレクトリ内に新しいサブディレクトリが存在しない場合は作成します。 詳細については、 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"));
client.createSubdirectoryIfNotExistsWithResponse(directoryName, options).subscribe(response -> {
if (response.getStatusCode() == 409) {
System.out.println("Already exists.");
} else {
System.out.println("successfully created.");
}
});
Parameters:
Returns:
createSubdirectoryWithResponse
public Mono
ディレクトリ内に新しいサブディレクトリを作成します。 同じ名前のサブディレクトリが既に存在する場合、サブディレクトリは上書きされます。 詳細については、 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 = CoreUtils.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);
DataLakeDirectoryAsyncClient newDirectoryClient = client.createSubdirectoryWithResponse(directoryName, options)
.block().getValue();
Parameters:
Returns:
createSubdirectoryWithResponse
public Mono
ディレクトリ内に新しいサブディレクトリを作成します。 同じ名前のサブディレクトリが既に存在する場合、サブディレクトリは上書きされます。 詳細については、 Azure Docs に関するページを参照してください。
コード サンプル
PathHttpHeaders httpHeaders = new PathHttpHeaders()
.setContentLanguage("en-US")
.setContentType("binary");
DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
.setLeaseId(leaseId);
String permissions = "permissions";
String umask = "umask";
DataLakeDirectoryAsyncClient newDirectoryClient = client.createSubdirectoryWithResponse(
directoryName, permissions, umask, httpHeaders, Collections.singletonMap("metadata", "value"),
requestConditions
).block().getValue();
Parameters:
Returns:
delete
public Mono
ディレクトリを削除します。
コード サンプル
client.delete().subscribe(response ->
System.out.println("Delete request completed"));
詳細については、Azure Docs に関するページを参照してください。
Returns:
deleteFile
public Mono
ファイル システム内の指定したファイルを削除します。 ファイルが存在しない場合、操作は失敗します。 詳細については、 Azure Docs を参照してください。
コード サンプル
client.deleteFile(fileName).subscribe(response ->
System.out.println("Delete request completed"));
Parameters:
Returns:
deleteFileIfExists
public Mono
ファイル システム内の指定したファイルが存在する場合は削除します。 詳細については、 Azure Docs を参照してください。
コード サンプル
client.deleteFileIfExists(fileName).subscribe(deleted -> {
if (deleted) {
System.out.println("successfully deleted.");
} else {
System.out.println("Does not exist.");
}
});
Parameters:
Returns:
true は、指定したファイルが正常に削除されたことを示し、 false 指定したファイルが存在しなかったことを示します。deleteFileIfExistsWithResponse
public Mono
ディレクトリ内の指定したファイルが存在する場合は削除します。 詳細については、 Azure Docs を参照してください。
コード サンプル
DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
.setLeaseId(leaseId);
DataLakePathDeleteOptions options = new DataLakePathDeleteOptions().setIsRecursive(false)
.setRequestConditions(requestConditions);
client.deleteFileIfExistsWithResponse(fileName, options).subscribe(response -> {
if (response.getStatusCode() == 404) {
System.out.println("Does not exist.");
} else {
System.out.println("successfully deleted.");
}
});
Parameters:
Returns:
deleteFileWithResponse
public Mono
ディレクトリ内の指定したファイルを削除します。 ファイルが存在しない場合、操作は失敗します。 詳細については、 Azure Docs を参照してください。
コード サンプル
DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
.setLeaseId(leaseId);
client.deleteFileWithResponse(fileName, requestConditions)
.subscribe(response -> System.out.println("Delete request completed"));
Parameters:
Returns:
deleteIfExists
public Mono
ディレクトリが存在する場合は削除します。
コード サンプル
client.deleteIfExists().subscribe(deleted -> {
if (deleted) {
System.out.println("Successfully deleted.");
} else {
System.out.println("Does not exist.");
}
});
詳細については、Azure Docs に関するページを参照してください。
Overrides:
DataLakeDirectoryAsyncClient.deleteIfExists()Returns:
true はディレクトリが正常に削除されたことを示し、 true ディレクトリが存在しなかったことを示します。deleteIfExistsWithResponse
public Mono
ディレクトリが存在する場合は削除します。
コード サンプル
DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
.setLeaseId(leaseId);
boolean recursive = false; // Default value
DataLakePathDeleteOptions options = new DataLakePathDeleteOptions().setIsRecursive(recursive)
.setRequestConditions(requestConditions);
client.deleteIfExistsWithResponse(options).subscribe(response -> {
if (response.getStatusCode() == 404) {
System.out.println("Does not exist.");
} else {
System.out.println("successfully deleted.");
}
});
詳細については、Azure Docs に関するページを参照してください。
Overrides:
DataLakeDirectoryAsyncClient.deleteIfExistsWithResponse(DataLakePathDeleteOptions options)Parameters:
Returns:
deleteRecursively
public Mono
ディレクトリとディレクトリ内のすべての内容を再帰的に削除します。
コード サンプル
client.deleteRecursively().subscribe(response ->
System.out.println("Delete request completed"));
詳細については、Azure Docs に関するページを参照してください。
Returns:
deleteRecursivelyWithResponse
public Mono
ディレクトリとディレクトリ内のすべての内容を再帰的に削除します。
コード サンプル
DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
.setLeaseId(leaseId);
boolean recursive = false; // Default value
client.deleteWithResponse(recursive, requestConditions)
.subscribe(response -> System.out.println("Delete request completed"));
詳細については、Azure Docs に関するページを参照してください。
Parameters:
Returns:
deleteSubdirectory
public Mono
ディレクトリ内の指定したサブディレクトリを削除します。 サブディレクトリが存在しないか、空でない場合、操作は失敗します。 詳細については、 Azure Docs を参照してください。
コード サンプル
client.deleteSubdirectory(directoryName).subscribe(response ->
System.out.println("Delete request completed"));
Parameters:
Returns:
deleteSubdirectoryIfExists
public Mono
ディレクトリ内の指定したサブディレクトリが存在する場合は削除します。 詳細については、 Azure Docs を参照してください。
コード サンプル
client.deleteSubdirectoryIfExists(directoryName).subscribe(deleted -> {
if (deleted) {
System.out.println("Successfully deleted.");
} else {
System.out.println("Does not exist.");
}
});
Parameters:
Returns:
true は、サブディレクトリが削除されたことを示します。
false は、指定したサブディレクトリが存在しないことを示します。deleteSubdirectoryIfExistsWithResponse
public Mono
ディレクトリ内の指定したサブディレクトリが存在する場合は削除します。 詳細については、 Azure Docs を参照してください。
コード サンプル
DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
.setLeaseId(leaseId);
boolean recursive = false; // Default value
DataLakePathDeleteOptions options = new DataLakePathDeleteOptions().setIsRecursive(recursive)
.setRequestConditions(requestConditions);
client.deleteSubdirectoryIfExistsWithResponse(directoryName, options).subscribe(response -> {
if (response.getStatusCode() == 404) {
System.out.println("Does not exist.");
} else {
System.out.println("successfully deleted.");
}
});
Parameters:
Returns:
deleteSubdirectoryWithResponse
public Mono
ディレクトリ内の指定したサブディレクトリを削除します。 サブディレクトリが存在しないか、空でない場合、操作は失敗します。 詳細については、 Azure Docs を参照してください。
コード サンプル
DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
.setLeaseId(leaseId);
boolean recursive = false; // Default value
client.deleteSubdirectoryWithResponse(directoryName, recursive, requestConditions)
.subscribe(response -> System.out.println("Delete request completed"));
Parameters:
Returns:
deleteWithResponse
public Mono
ディレクトリを削除します。
コード サンプル
DataLakeRequestConditions requestConditions = new DataLakeRequestConditions()
.setLeaseId(leaseId);
boolean recursive = false; // Default value
client.deleteWithResponse(recursive, requestConditions)
.subscribe(response -> System.out.println("Delete request completed"));
詳細については、Azure Docs に関するページを参照してください。
Parameters:
Returns:
getCustomerProvidedKeyAsyncClient
public DataLakeDirectoryAsyncClient getCustomerProvidedKeyAsyncClient(CustomerProvidedKey customerProvidedKey)
指定した DataLakeDirectoryAsyncClient を使用して、新しい customerProvidedKey を作成します。
Overrides:
DataLakeDirectoryAsyncClient.getCustomerProvidedKeyAsyncClient(CustomerProvidedKey customerProvidedKey)Parameters:
Returns:
customerProvidedKeyを持つ 。getDirectoryName
public String getDirectoryName()
完全パスを含まない、このディレクトリの名前を取得します。
Returns:
getDirectoryPath
public String getDirectoryPath()
リソース自体の名前を含まない、このディレクトリのパスを取得します。
Returns:
getDirectoryUrl
public String getDirectoryUrl()
Data Lake サービスでこのクライアントによって表されるディレクトリの URL を取得します。
Returns:
getFileAsyncClient
public DataLakeFileAsyncClient getFileAsyncClient(String fileName)
fileName を DataLakeDirectoryAsyncClient の URL の末尾に連結して、新しい DataLakeFileAsyncClient オブジェクトを作成します。 新しい DataLakeFileAsyncClient は、DataLakeDirectoryAsyncClient と同じ要求ポリシー パイプラインを使用します。
コード サンプル
DataLakeFileAsyncClient dataLakeFileClient = client.getFileAsyncClient(fileName);
Parameters:
Stringファイルの名前を表す 。
Returns:
getSubdirectoryAsyncClient
public DataLakeDirectoryAsyncClient getSubdirectoryAsyncClient(String subdirectoryName)
サブディレクトリ名を DataLakeDirectoryAsyncClient の URL の末尾に連結して、新しい DataLakeDirectoryAsyncClient オブジェクトを作成します。 新しい DataLakeDirectoryAsyncClient は、DataLakeDirectoryAsyncClient と同じ要求ポリシー パイプラインを使用します。
コード サンプル
DataLakeDirectoryAsyncClient dataLakeDirectoryClient = client.getSubdirectoryAsyncClient(directoryName);
Parameters:
Stringサブディレクトリの名前を表す 。
Returns:
listPaths
public PagedFlux
必要に応じて、このディレクトリ内のすべてのファイル/ディレクトリを遅延して出力するリアクティブパブリッシャーを返します。 詳細については、 Azure Docs に関するページを参照してください。
コード サンプル
client.listPaths().subscribe(path -> System.out.printf("Name: %s%n", path.getName()));
Returns:
listPaths
public PagedFlux
必要に応じて、このディレクトリ内のすべてのファイル/ディレクトリを遅延して出力するリアクティブパブリッシャーを返します。 詳細については、 Azure Docs に関するページを参照してください。
コード サンプル
client.listPaths(false, false, 10)
.subscribe(path -> System.out.printf("Name: %s%n", path.getName()));
Parameters:
Returns:
rename
public Mono
ディレクトリをファイル システム内の別の場所に移動します。 詳細については、 Azure Docs を参照してください。
コード サンプル
DataLakeDirectoryAsyncClient renamedClient = client.rename(fileSystemName, destinationPath).block();
System.out.println("Directory Client has been renamed");
Parameters:
null 現在のファイル システムの場合は 。
Returns:
renameWithResponse
public Mono
ディレクトリをファイル システム内の別の場所に移動します。 詳細については、 Azure Docs に関するページを参照してください。
コード サンプル
DataLakeRequestConditions sourceRequestConditions = new DataLakeRequestConditions()
.setLeaseId(leaseId);
DataLakeRequestConditions destinationRequestConditions = new DataLakeRequestConditions();
DataLakeDirectoryAsyncClient newRenamedClient = client.renameWithResponse(fileSystemName, destinationPath,
sourceRequestConditions, destinationRequestConditions).block().getValue();
System.out.println("Directory Client has been renamed");
Parameters:
null 現在のファイル システムの場合は 。
Returns:
適用対象
Azure SDK for Java