azure-docs-sdk-java/archive/docs-ref-autogen/com.microsoft.azure.storage...

444 строки
45 KiB
YAML
Исходник Постоянная ссылка Обычный вид История

2020-12-04 07:30:31 +03:00
### YamlMime:JavaType
constructors:
- fullName: com.microsoft.azure.storage.table.CloudTableClient.CloudTableClient(final StorageUri baseUri, StorageCredentials credentials)
name: CloudTableClient(final StorageUri baseUri, StorageCredentials credentials)
nameWithType: CloudTableClient.CloudTableClient(final StorageUri baseUri, StorageCredentials credentials)
parameters:
- description: <p>A <xref uid="com.microsoft.azure.storage.StorageUri" data-throw-if-not-resolved="false" data-raw-source="StorageUri"></xref> object that represents the Table service endpoint used to initialize the client. </p>
name: baseUri
type: final <xref href="com.microsoft.azure.storage.StorageUri?alt=com.microsoft.azure.storage.StorageUri&text=StorageUri" data-throw-if-not-resolved="False"/>
- description: <p>A <xref uid="com.microsoft.azure.storage.StorageCredentials" data-throw-if-not-resolved="false" data-raw-source="StorageCredentials"></xref> object that represents the storage account credentials for access. </p>
name: credentials
type: <xref href="com.microsoft.azure.storage.StorageCredentials?alt=com.microsoft.azure.storage.StorageCredentials&text=StorageCredentials" data-throw-if-not-resolved="False"/>
summary: >-
<p>Initializes an instance of the class using a Table service endpoint and storage account credentials.</p>
<p></p>
syntax: public CloudTableClient(final StorageUri baseUri, StorageCredentials credentials)
uid: com.microsoft.azure.storage.table.CloudTableClient.CloudTableClient(final StorageUri,StorageCredentials)
- fullName: com.microsoft.azure.storage.table.CloudTableClient.CloudTableClient(final URI baseUri, StorageCredentials credentials)
name: CloudTableClient(final URI baseUri, StorageCredentials credentials)
nameWithType: CloudTableClient.CloudTableClient(final URI baseUri, StorageCredentials credentials)
parameters:
- description: <p>A <code>java.net.URI</code> object that represents the Table service endpoint used to initialize the client. </p>
name: baseUri
type: <xref href="final+URI?alt=final+URI&text=final+URI" data-throw-if-not-resolved="False"/>
- description: <p>A <xref uid="com.microsoft.azure.storage.StorageCredentials" data-throw-if-not-resolved="false" data-raw-source="StorageCredentials"></xref> object that represents the storage account credentials for access. </p>
name: credentials
type: <xref href="com.microsoft.azure.storage.StorageCredentials?alt=com.microsoft.azure.storage.StorageCredentials&text=StorageCredentials" data-throw-if-not-resolved="False"/>
summary: >-
<p>Initializes an instance of the class using a Table service endpoint and storage account credentials.</p>
<p></p>
syntax: public CloudTableClient(final URI baseUri, StorageCredentials credentials)
uid: com.microsoft.azure.storage.table.CloudTableClient.CloudTableClient(final URI,StorageCredentials)
2020-12-04 07:30:31 +03:00
inheritances:
- <xref href="java.lang.Object" data-throw-if-not-resolved="False"/>
- <xref href="com.microsoft.azure.storage.ServiceClient?alt=com.microsoft.azure.storage.ServiceClient&text=ServiceClient" data-throw-if-not-resolved="False"/>
inheritedMembers:
- com.microsoft.azure.storage.ServiceClient.credentials
- com.microsoft.azure.storage.ServiceClient.downloadServicePropertiesImpl(final RequestOptions,final boolean)
- com.microsoft.azure.storage.ServiceClient.getCredentials()
- com.microsoft.azure.storage.ServiceClient.getEndpoint()
- com.microsoft.azure.storage.ServiceClient.getServiceStatsImpl(final RequestOptions,final boolean)
- com.microsoft.azure.storage.ServiceClient.getStorageUri()
- com.microsoft.azure.storage.ServiceClient.ServiceClient(final StorageUri,final StorageCredentials)
- com.microsoft.azure.storage.ServiceClient.setCredentials(final StorageCredentials)
- com.microsoft.azure.storage.ServiceClient.setStorageUri(final StorageUri)
- com.microsoft.azure.storage.ServiceClient.uploadServicePropertiesImpl(final ServiceProperties,final RequestOptions,final OperationContext,final boolean)
methods:
- fullName: com.microsoft.azure.storage.table.CloudTableClient.downloadServiceProperties()
name: downloadServiceProperties()
nameWithType: CloudTableClient.downloadServiceProperties()
exceptions:
- type: <xref href="StorageException?alt=StorageException&text=StorageException" data-throw-if-not-resolved="False"/>
description: <p>If a storage service error occurred. </p>
returns:
description: <p>the <xref uid="com.microsoft.azure.storage.ServiceProperties" data-throw-if-not-resolved="false" data-raw-source="ServiceProperties"></xref> object representing the current configuration of the service. </p>
type: final <xref href="com.microsoft.azure.storage.ServiceProperties?alt=com.microsoft.azure.storage.ServiceProperties&text=ServiceProperties" data-throw-if-not-resolved="False"/>
summary: >-
<p>Retrieves the current <xref uid="com.microsoft.azure.storage.ServiceProperties" data-throw-if-not-resolved="false" data-raw-source="ServiceProperties"></xref> for the given storage service. This includes Logging, HourMetrics, MinuteMetrics and CORS configurations.</p>
<p></p>
syntax: public final ServiceProperties downloadServiceProperties()
uid: com.microsoft.azure.storage.table.CloudTableClient.downloadServiceProperties()
- fullName: com.microsoft.azure.storage.table.CloudTableClient.downloadServiceProperties(TableRequestOptions options, OperationContext opContext)
name: downloadServiceProperties(TableRequestOptions options, OperationContext opContext)
nameWithType: CloudTableClient.downloadServiceProperties(TableRequestOptions options, OperationContext opContext)
parameters:
- description: <p>A <xref uid="" data-throw-if-not-resolved="false" data-raw-source="BlobRequestOptions"></xref> object that specifies any additional options for the request. Specifying <code>null</code> will use the default request options from the associated service client ( <xref uid="" data-throw-if-not-resolved="false" data-raw-source="CloudBlobClient"></xref>). </p>
name: options
type: <xref href="com.microsoft.azure.storage.table.TableRequestOptions?alt=com.microsoft.azure.storage.table.TableRequestOptions&text=TableRequestOptions" data-throw-if-not-resolved="False"/>
- description: <p>An <xref uid="com.microsoft.azure.storage.OperationContext" data-throw-if-not-resolved="false" data-raw-source="OperationContext"></xref> object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.</p>
name: opContext
type: <xref href="com.microsoft.azure.storage.OperationContext?alt=com.microsoft.azure.storage.OperationContext&text=OperationContext" data-throw-if-not-resolved="False"/>
exceptions:
- type: <xref href="StorageException?alt=StorageException&text=StorageException" data-throw-if-not-resolved="False"/>
description: <p>If a storage service error occurred. </p>
returns:
description: <p>the <xref uid="com.microsoft.azure.storage.ServiceProperties" data-throw-if-not-resolved="false" data-raw-source="ServiceProperties"></xref> object representing the current configuration of the service. </p>
type: final <xref href="com.microsoft.azure.storage.ServiceProperties?alt=com.microsoft.azure.storage.ServiceProperties&text=ServiceProperties" data-throw-if-not-resolved="False"/>
summary: >-
<p>Retrieves the current <xref uid="com.microsoft.azure.storage.ServiceProperties" data-throw-if-not-resolved="false" data-raw-source="ServiceProperties"></xref> for the given storage service. This includes Logging, HourMetrics, MinuteMetrics and CORS configurations.</p>
<p></p>
syntax: public final ServiceProperties downloadServiceProperties(TableRequestOptions options, OperationContext opContext)
uid: com.microsoft.azure.storage.table.CloudTableClient.downloadServiceProperties(TableRequestOptions,OperationContext)
- fullName: com.microsoft.azure.storage.table.CloudTableClient.executeQuerySegmentedImpl(final TableQuery<T> queryToExecute, final EntityResolver<R> resolver, final ResultContinuation continuationToken, TableRequestOptions options, OperationContext opContext)
name: executeQuerySegmentedImpl(final TableQuery<T> queryToExecute, final EntityResolver<R> resolver, final ResultContinuation continuationToken, TableRequestOptions options, OperationContext opContext)
nameWithType: CloudTableClient.executeQuerySegmentedImpl(final TableQuery<T> queryToExecute, final EntityResolver<R> resolver, final ResultContinuation continuationToken, TableRequestOptions options, OperationContext opContext)
parameters:
- description: <p>The <xref uid="com.microsoft.azure.storage.table.TableQuery" data-throw-if-not-resolved="false" data-raw-source="TableQuery"></xref> to execute. </p>
name: queryToExecute
type: final <xref href="com.microsoft.azure.storage.table.TableQuery?alt=com.microsoft.azure.storage.table.TableQuery&text=TableQuery" data-throw-if-not-resolved="False"/>&lt;T&gt;
- description: <p>An <xref uid="com.microsoft.azure.storage.table.EntityResolver" data-throw-if-not-resolved="false" data-raw-source="EntityResolver"></xref> instance which creates a projection of the table query result entities into the specified type <code>R</code>. Pass <code>null</code> to return the results as the table entity type. </p>
name: resolver
type: final <xref href="com.microsoft.azure.storage.table.EntityResolver?alt=com.microsoft.azure.storage.table.EntityResolver&text=EntityResolver" data-throw-if-not-resolved="False"/>&lt;R&gt;
- description: <p>The <xref uid="com.microsoft.azure.storage.ResultContinuation" data-throw-if-not-resolved="false" data-raw-source="ResultContinuation"></xref> to pass with the operation to resume a query, if any. Pass <code>null</code> for an initial query. </p>
name: continuationToken
type: final <xref href="com.microsoft.azure.storage.ResultContinuation?alt=com.microsoft.azure.storage.ResultContinuation&text=ResultContinuation" data-throw-if-not-resolved="False"/>
- description: <p>A <xref uid="com.microsoft.azure.storage.table.TableRequestOptions" data-throw-if-not-resolved="false" data-raw-source="TableRequestOptions"></xref> object that specifies execution options such as retry policy and timeout settings for the operation. Specify <code>null</code> to use the request options specified on the <xref uid="com.microsoft.azure.storage.table.CloudTableClient" data-throw-if-not-resolved="false" data-raw-source="CloudTableClient"></xref>. </p>
name: options
type: <xref href="com.microsoft.azure.storage.table.TableRequestOptions?alt=com.microsoft.azure.storage.table.TableRequestOptions&text=TableRequestOptions" data-throw-if-not-resolved="False"/>
- description: <p>An <xref uid="com.microsoft.azure.storage.OperationContext" data-throw-if-not-resolved="false" data-raw-source="OperationContext"></xref> object for tracking the current operation. Specify <code>null</code> to safely ignore operation context. </p>
name: opContext
type: <xref href="com.microsoft.azure.storage.OperationContext?alt=com.microsoft.azure.storage.OperationContext&text=OperationContext" data-throw-if-not-resolved="False"/>
exceptions:
- type: <xref href="StorageException?alt=StorageException&text=StorageException" data-throw-if-not-resolved="False"/>
description: <p>if a Storage service error occurs. </p>
returns:
description: <p>A <xref uid="com.microsoft.azure.storage.ResultSegment" data-throw-if-not-resolved="false" data-raw-source="ResultSegment"></xref> containing a collection of the query results specialized for the <xref uid="com.microsoft.azure.storage.table.TableEntity" data-throw-if-not-resolved="false" data-raw-source="TableEntity"></xref> or <xref uid="com.microsoft.azure.storage.table.EntityResolver" data-throw-if-not-resolved="false" data-raw-source="EntityResolver"></xref> type returned by the query. </p>
type: '&lt;T extends <xref href="com.microsoft.azure.storage.table.TableEntity?alt=com.microsoft.azure.storage.table.TableEntity&text=TableEntity" data-throw-if-not-resolved="False"/>, R&gt; <xref href="com.microsoft.azure.storage.ResultSegment?alt=com.microsoft.azure.storage.ResultSegment&text=ResultSegment" data-throw-if-not-resolved="False"/>&lt;?&gt;'
summary: >-
<p>Reserved for internal use. Executes a segmented query operation using the specified retry and timeout policies.</p>
<p></p>
syntax: protected <T extends TableEntity, R> ResultSegment<?> executeQuerySegmentedImpl(final TableQuery<T> queryToExecute, final EntityResolver<R> resolver, final ResultContinuation continuationToken, TableRequestOptions options, OperationContext opContext)
uid: com.microsoft.azure.storage.table.CloudTableClient.executeQuerySegmentedImpl(final TableQuery<T>,final EntityResolver<R>,final ResultContinuation,TableRequestOptions,OperationContext)
- fullName: com.microsoft.azure.storage.table.CloudTableClient.generateIteratorForQuery(final TableQuery<T> queryRef, final EntityResolver<R> resolver, TableRequestOptions options, OperationContext opContext)
name: generateIteratorForQuery(final TableQuery<T> queryRef, final EntityResolver<R> resolver, TableRequestOptions options, OperationContext opContext)
nameWithType: CloudTableClient.generateIteratorForQuery(final TableQuery<T> queryRef, final EntityResolver<R> resolver, TableRequestOptions options, OperationContext opContext)
parameters:
- description: <p>The <xref uid="com.microsoft.azure.storage.table.TableQuery" data-throw-if-not-resolved="false" data-raw-source="TableQuery"></xref> to execute. </p>
name: queryRef
type: final <xref href="com.microsoft.azure.storage.table.TableQuery?alt=com.microsoft.azure.storage.table.TableQuery&text=TableQuery" data-throw-if-not-resolved="False"/>&lt;T&gt;
- description: <p>An <xref uid="com.microsoft.azure.storage.table.EntityResolver" data-throw-if-not-resolved="false" data-raw-source="EntityResolver"></xref> instance which creates a projection of the table query result entities into the specified type <code>R</code>. Pass <code>null</code> to return the results as the table entity type. </p>
name: resolver
type: final <xref href="com.microsoft.azure.storage.table.EntityResolver?alt=com.microsoft.azure.storage.table.EntityResolver&text=EntityResolver" data-throw-if-not-resolved="False"/>&lt;R&gt;
- description: <p>A <xref uid="com.microsoft.azure.storage.table.TableRequestOptions" data-throw-if-not-resolved="false" data-raw-source="TableRequestOptions"></xref> object that specifies execution options such as retry policy and timeout settings for the operation. Specify <code>null</code> to use the request options specified on the <xref uid="com.microsoft.azure.storage.table.CloudTableClient" data-throw-if-not-resolved="false" data-raw-source="CloudTableClient"></xref>. </p>
name: options
type: <xref href="com.microsoft.azure.storage.table.TableRequestOptions?alt=com.microsoft.azure.storage.table.TableRequestOptions&text=TableRequestOptions" data-throw-if-not-resolved="False"/>
- description: <p>An <xref uid="com.microsoft.azure.storage.OperationContext" data-throw-if-not-resolved="false" data-raw-source="OperationContext"></xref> object for tracking the current operation. Specify <code>null</code> to safely ignore operation context. </p>
name: opContext
type: <xref href="com.microsoft.azure.storage.OperationContext?alt=com.microsoft.azure.storage.OperationContext&text=OperationContext" data-throw-if-not-resolved="False"/>
returns:
description: <p>An instance of <code>Iterable</code> specialized for the <xref uid="com.microsoft.azure.storage.table.TableEntity" data-throw-if-not-resolved="false" data-raw-source="TableEntity"></xref> or <xref uid="com.microsoft.azure.storage.table.EntityResolver" data-throw-if-not-resolved="false" data-raw-source="EntityResolver"></xref> type returned by the query. </p>
type: '&lt;T extends <xref href="com.microsoft.azure.storage.table.TableEntity?alt=com.microsoft.azure.storage.table.TableEntity&text=TableEntity" data-throw-if-not-resolved="False"/>, R&gt; Iterable&lt;?&gt;'
summary: >-
<p>Reserved for internal use. Generates an iterator for a segmented query operation.</p>
<p></p>
syntax: protected <T extends TableEntity, R> Iterable<?> generateIteratorForQuery(final TableQuery<T> queryRef, final EntityResolver<R> resolver, TableRequestOptions options, OperationContext opContext)
uid: com.microsoft.azure.storage.table.CloudTableClient.generateIteratorForQuery(final TableQuery<T>,final EntityResolver<R>,TableRequestOptions,OperationContext)
- fullName: com.microsoft.azure.storage.table.CloudTableClient.getDefaultRequestOptions()
name: getDefaultRequestOptions()
nameWithType: CloudTableClient.getDefaultRequestOptions()
returns:
description: <p>The <xref uid="com.microsoft.azure.storage.table.TableRequestOptions" data-throw-if-not-resolved="false" data-raw-source="TableRequestOptions"></xref> object containing the values used by this <code>CloudTableClient</code></p>
type: <xref href="com.microsoft.azure.storage.table.TableRequestOptions?alt=com.microsoft.azure.storage.table.TableRequestOptions&text=TableRequestOptions" data-throw-if-not-resolved="False"/>
summary: >-
<p>Gets the <xref uid="com.microsoft.azure.storage.table.TableRequestOptions" data-throw-if-not-resolved="false" data-raw-source="TableRequestOptions"></xref> that is used for requests associated with this </p>
<p></p>
syntax: public TableRequestOptions getDefaultRequestOptions()
uid: com.microsoft.azure.storage.table.CloudTableClient.getDefaultRequestOptions()
- fullName: com.microsoft.azure.storage.table.CloudTableClient.getServiceStats()
name: getServiceStats()
nameWithType: CloudTableClient.getServiceStats()
exceptions:
- type: <xref href="StorageException?alt=StorageException&text=StorageException" data-throw-if-not-resolved="False"/>
description: <p>If a storage service error occurred. </p>
returns:
description: >-
<p>
<xref uid="com.microsoft.azure.storage.ServiceStats" data-throw-if-not-resolved="false" data-raw-source="ServiceStats"></xref> for the given storage service </p>
type: <xref href="com.microsoft.azure.storage.ServiceStats?alt=com.microsoft.azure.storage.ServiceStats&text=ServiceStats" data-throw-if-not-resolved="False"/>
summary: >-
<p>Queries the service for the <xref uid="com.microsoft.azure.storage.ServiceStats" data-throw-if-not-resolved="false" data-raw-source="ServiceStats"></xref>.</p>
<p></p>
syntax: public ServiceStats getServiceStats()
uid: com.microsoft.azure.storage.table.CloudTableClient.getServiceStats()
- fullName: com.microsoft.azure.storage.table.CloudTableClient.getServiceStats(TableRequestOptions options, OperationContext opContext)
name: getServiceStats(TableRequestOptions options, OperationContext opContext)
nameWithType: CloudTableClient.getServiceStats(TableRequestOptions options, OperationContext opContext)
parameters:
- description: <p>A <xref uid="" data-throw-if-not-resolved="false" data-raw-source="BlobRequestOptions"></xref> object that specifies any additional options for the request. Specifying <code>null</code> will use the default request options from the associated service client ( <xref uid="" data-throw-if-not-resolved="false" data-raw-source="CloudBlobClient"></xref>). </p>
name: options
type: <xref href="com.microsoft.azure.storage.table.TableRequestOptions?alt=com.microsoft.azure.storage.table.TableRequestOptions&text=TableRequestOptions" data-throw-if-not-resolved="False"/>
- description: <p>An <xref uid="com.microsoft.azure.storage.OperationContext" data-throw-if-not-resolved="false" data-raw-source="OperationContext"></xref> object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation. </p>
name: opContext
type: <xref href="com.microsoft.azure.storage.OperationContext?alt=com.microsoft.azure.storage.OperationContext&text=OperationContext" data-throw-if-not-resolved="False"/>
exceptions:
- type: <xref href="StorageException?alt=StorageException&text=StorageException" data-throw-if-not-resolved="False"/>
description: <p>If a storage service error occurred. </p>
returns:
description: >-
<p>
<xref uid="com.microsoft.azure.storage.ServiceStats" data-throw-if-not-resolved="false" data-raw-source="ServiceStats"></xref> for the given storage service </p>
type: <xref href="com.microsoft.azure.storage.ServiceStats?alt=com.microsoft.azure.storage.ServiceStats&text=ServiceStats" data-throw-if-not-resolved="False"/>
summary: >-
<p>Queries the given storage service for the <xref uid="com.microsoft.azure.storage.ServiceStats" data-throw-if-not-resolved="false" data-raw-source="ServiceStats"></xref>.</p>
<p></p>
syntax: public ServiceStats getServiceStats(TableRequestOptions options, OperationContext opContext)
uid: com.microsoft.azure.storage.table.CloudTableClient.getServiceStats(TableRequestOptions,OperationContext)
- fullName: com.microsoft.azure.storage.table.CloudTableClient.getTableReference(final String tableName)
name: getTableReference(final String tableName)
nameWithType: CloudTableClient.getTableReference(final String tableName)
parameters:
- description: <p>A <code>String</code> which represents the name of the table, which must adhere to table naming rules. The table name should not include any path separator characters (/). Table names are case insensitive, must be unique within an account and must be between 3-63 characters long. Table names must start with an cannot begin with a numeric character and may only contain alphanumeric characters. Some table names are reserved, including "table".</p>
name: tableName
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
exceptions:
- type: <xref href="URISyntaxException?alt=URISyntaxException&text=URISyntaxException" data-throw-if-not-resolved="False"/>
description: <p>If the resource URI constructed based on the tableName is invalid. </p>
- type: <xref href="StorageException?alt=StorageException&text=StorageException" data-throw-if-not-resolved="False"/>
description: <p>If a storage service error occurred. </p>
returns:
description: <p>A reference to a <xref uid="com.microsoft.azure.storage.table.CloudTable" data-throw-if-not-resolved="false" data-raw-source="CloudTable"></xref> object.</p>
type: <xref href="com.microsoft.azure.storage.table.CloudTable?alt=com.microsoft.azure.storage.table.CloudTable&text=CloudTable" data-throw-if-not-resolved="False"/>
summary: >-
<p>Gets a <xref uid="com.microsoft.azure.storage.table.CloudTable" data-throw-if-not-resolved="false" data-raw-source="CloudTable"></xref> object with the specified name.</p>
<p></p>
syntax: public CloudTable getTableReference(final String tableName)
uid: com.microsoft.azure.storage.table.CloudTableClient.getTableReference(final String)
- fullName: com.microsoft.azure.storage.table.CloudTableClient.getTransformedEndPoint(final OperationContext opContext)
name: getTransformedEndPoint(final OperationContext opContext)
nameWithType: CloudTableClient.getTransformedEndPoint(final OperationContext opContext)
parameters:
- name: opContext
type: final <xref href="com.microsoft.azure.storage.OperationContext?alt=com.microsoft.azure.storage.OperationContext&text=OperationContext" data-throw-if-not-resolved="False"/>
returns:
type: final <xref href="com.microsoft.azure.storage.StorageUri?alt=com.microsoft.azure.storage.StorageUri&text=StorageUri" data-throw-if-not-resolved="False"/>
syntax: protected final StorageUri getTransformedEndPoint(final OperationContext opContext)
uid: com.microsoft.azure.storage.table.CloudTableClient.getTransformedEndPoint(final OperationContext)
- fullName: com.microsoft.azure.storage.table.CloudTableClient.isUsePathStyleUris()
name: isUsePathStyleUris()
nameWithType: CloudTableClient.isUsePathStyleUris()
returns:
description: >-
<p>
<code>true</code> if path-style URIs are used; otherwise <code>false</code>. </p>
type: <xref href="boolean?alt=boolean&text=boolean" data-throw-if-not-resolved="False"/>
summary: >-
<p>Indicates whether path-style URIs are used.</p>
<p></p>
syntax: protected boolean isUsePathStyleUris()
uid: com.microsoft.azure.storage.table.CloudTableClient.isUsePathStyleUris()
- fullName: com.microsoft.azure.storage.table.CloudTableClient.listTables()
name: listTables()
nameWithType: CloudTableClient.listTables()
returns:
description: <p>An <code>Iterable</code> collection of the table names in the storage account retrieved lazily. </p>
type: <xref href="Iterable%3CString%3E?alt=Iterable%3CString%3E&text=Iterable%3CString%3E" data-throw-if-not-resolved="False"/>
summary: >-
<p>Lists the table names in the storage account. </p>
<p>This method invokes the <a href="http://msdn.microsoft.com/en-us/library/azure/dd179405.aspx">Query Tables</a> REST API to list the table names, using the Table service endpoint and storage account credentials of this instance.</p>
<p></p>
syntax: public Iterable<String> listTables()
uid: com.microsoft.azure.storage.table.CloudTableClient.listTables()
- fullName: com.microsoft.azure.storage.table.CloudTableClient.listTables(final String prefix)
name: listTables(final String prefix)
nameWithType: CloudTableClient.listTables(final String prefix)
parameters:
- description: <p>A <code>String</code> containing the prefix to match on table names to return.</p>
name: prefix
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
returns:
description: <p>An <code>Iterable</code> collection of the table names in the storage account retrieved lazily that match the specified prefix. </p>
type: <xref href="Iterable%3CString%3E?alt=Iterable%3CString%3E&text=Iterable%3CString%3E" data-throw-if-not-resolved="False"/>
summary: >-
<p>Lists the table names in the storage account that match the specified prefix. </p>
<p>This method invokes the <a href="http://msdn.microsoft.com/en-us/library/azure/dd179405.aspx">Query Tables</a> REST API to list the table names that match the prefix, using the Table service endpoint and storage account credentials of this instance.</p>
<p></p>
syntax: public Iterable<String> listTables(final String prefix)
uid: com.microsoft.azure.storage.table.CloudTableClient.listTables(final String)
- fullName: com.microsoft.azure.storage.table.CloudTableClient.listTables(final String prefix, final TableRequestOptions options, final OperationContext opContext)
name: listTables(final String prefix, final TableRequestOptions options, final OperationContext opContext)
nameWithType: CloudTableClient.listTables(final String prefix, final TableRequestOptions options, final OperationContext opContext)
parameters:
- description: <p>A <code>String</code> containing the prefix to match on table names to return. </p>
name: prefix
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
- description: <p>A <xref uid="com.microsoft.azure.storage.table.TableRequestOptions" data-throw-if-not-resolved="false" data-raw-source="TableRequestOptions"></xref> object that specifies execution options such as retry policy and timeout settings for the operation. Specify <code>null</code> to use the request options specified on the <xref uid="com.microsoft.azure.storage.table.CloudTableClient" data-throw-if-not-resolved="false" data-raw-source="CloudTableClient"></xref>. </p>
name: options
type: final <xref href="com.microsoft.azure.storage.table.TableRequestOptions?alt=com.microsoft.azure.storage.table.TableRequestOptions&text=TableRequestOptions" data-throw-if-not-resolved="False"/>
- description: <p>An <xref uid="com.microsoft.azure.storage.OperationContext" data-throw-if-not-resolved="false" data-raw-source="OperationContext"></xref> object for tracking the current operation. Specify <code>null</code> to safely ignore operation context.</p>
name: opContext
type: final <xref href="com.microsoft.azure.storage.OperationContext?alt=com.microsoft.azure.storage.OperationContext&text=OperationContext" data-throw-if-not-resolved="False"/>
returns:
description: <p>An <code>Iterable</code> collection of the table names in the storage account retrieved lazily that match the specified prefix. </p>
type: <xref href="Iterable%3CString%3E?alt=Iterable%3CString%3E&text=Iterable%3CString%3E" data-throw-if-not-resolved="False"/>
summary: >-
<p>Lists the table names in the storage account that match the specified prefix, using the specified <xref uid="com.microsoft.azure.storage.table.TableRequestOptions" data-throw-if-not-resolved="false" data-raw-source="TableRequestOptions"></xref> and <xref uid="com.microsoft.azure.storage.OperationContext" data-throw-if-not-resolved="false" data-raw-source="OperationContext"></xref>. </p>
<p>This method invokes the <a href="http://msdn.microsoft.com/en-us/library/azure/dd179405.aspx">Query Tables</a> REST API to list the table names that match the prefix, using the Table service endpoint and storage account credentials of this instance.</p>
<p>Use the <xref uid="com.microsoft.azure.storage.table.TableRequestOptions" data-throw-if-not-resolved="false" data-raw-source="TableRequestOptions"></xref> to override execution options such as the timeout or retry policy for the operation.</p>
<p></p>
syntax: public Iterable<String> listTables(final String prefix, final TableRequestOptions options, final OperationContext opContext)
uid: com.microsoft.azure.storage.table.CloudTableClient.listTables(final String,final TableRequestOptions,final OperationContext)
- fullName: com.microsoft.azure.storage.table.CloudTableClient.listTablesSegmented()
name: listTablesSegmented()
nameWithType: CloudTableClient.listTablesSegmented()
exceptions:
- type: <xref href="StorageException?alt=StorageException&text=StorageException" data-throw-if-not-resolved="False"/>
description: <p>if a storage service error occurred during the operation. </p>
returns:
description: <p>A <xref uid="com.microsoft.azure.storage.ResultSegment" data-throw-if-not-resolved="false" data-raw-source="ResultSegment"></xref> of <code>String</code> objects containing table names in the storage account.</p>
type: <xref href="com.microsoft.azure.storage.ResultSegment?alt=com.microsoft.azure.storage.ResultSegment&text=ResultSegment" data-throw-if-not-resolved="False"/>&lt;String&gt;
summary: >-
<p>Lists the table names in the storage account in segmented mode. This method allows listing of tables to be resumed after returning a partial set of results, using information returned by the server in the <xref uid="com.microsoft.azure.storage.ResultSegment" data-throw-if-not-resolved="false" data-raw-source="ResultSegment"></xref> object. </p>
<p>This method invokes the <a href="http://msdn.microsoft.com/en-us/library/azure/dd179405.aspx">Query Tables</a> REST API to list the table names, using the Table service endpoint and storage account credentials of this instance.</p>
<p></p>
syntax: public ResultSegment<String> listTablesSegmented()
uid: com.microsoft.azure.storage.table.CloudTableClient.listTablesSegmented()
- fullName: com.microsoft.azure.storage.table.CloudTableClient.listTablesSegmented(final String prefix)
name: listTablesSegmented(final String prefix)
nameWithType: CloudTableClient.listTablesSegmented(final String prefix)
parameters:
- description: <p>A <code>String</code> containing the prefix to match on table names to return.</p>
name: prefix
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
exceptions:
- type: <xref href="StorageException?alt=StorageException&text=StorageException" data-throw-if-not-resolved="False"/>
description: <p>if a storage service error occurred during the operation. </p>
returns:
description: <p>A <xref uid="com.microsoft.azure.storage.ResultSegment" data-throw-if-not-resolved="false" data-raw-source="ResultSegment"></xref> of <code>String</code> objects containing table names matching the prefix in the storage account.</p>
type: <xref href="com.microsoft.azure.storage.ResultSegment?alt=com.microsoft.azure.storage.ResultSegment&text=ResultSegment" data-throw-if-not-resolved="False"/>&lt;String&gt;
summary: >-
<p>Lists the table names in the storage account that match the specified prefix in segmented mode. This method allows listing of tables to be resumed after returning a partial set of results, using information returned by the server in the <xref uid="com.microsoft.azure.storage.ResultSegment" data-throw-if-not-resolved="false" data-raw-source="ResultSegment"></xref> object. </p>
<p>This method invokes the <a href="http://msdn.microsoft.com/en-us/library/azure/dd179405.aspx">Query Tables</a> REST API to list the table names that match the prefix, using the Table service endpoint and storage account credentials of this instance.</p>
<p></p>
syntax: public ResultSegment<String> listTablesSegmented(final String prefix)
uid: com.microsoft.azure.storage.table.CloudTableClient.listTablesSegmented(final String)
- fullName: com.microsoft.azure.storage.table.CloudTableClient.listTablesSegmented(final String prefix, final Integer maxResults, final ResultContinuation continuationToken, final TableRequestOptions options, final OperationContext opContext)
name: listTablesSegmented(final String prefix, final Integer maxResults, final ResultContinuation continuationToken, final TableRequestOptions options, final OperationContext opContext)
nameWithType: CloudTableClient.listTablesSegmented(final String prefix, final Integer maxResults, final ResultContinuation continuationToken, final TableRequestOptions options, final OperationContext opContext)
parameters:
- description: <p>A <code>String</code> containing the prefix to match on table names to return. </p>
name: prefix
type: <xref href="final+String?alt=final+String&text=final+String" data-throw-if-not-resolved="False"/>
- description: <p>The maximum number of table names to return in the <xref uid="com.microsoft.azure.storage.ResultSegment" data-throw-if-not-resolved="false" data-raw-source="ResultSegment"></xref>. If this parameter is null, the query will list up to the maximum 1,000 results. </p>
name: maxResults
type: <xref href="final+Integer?alt=final+Integer&text=final+Integer" data-throw-if-not-resolved="False"/>
- description: <p>A <xref uid="com.microsoft.azure.storage.ResultContinuation" data-throw-if-not-resolved="false" data-raw-source="ResultContinuation"></xref> object representing a continuation token from the server when the operation returns a partial result. Specify <code>null</code> on the initial call. Call the <xref uid="com.microsoft.azure.storage.ResultSegment.getContinuationToken()" data-throw-if-not-resolved="false" data-raw-source="ResultSegment#getContinuationToken()"></xref> method on the result to obtain the <xref uid="com.microsoft.azure.storage.ResultContinuation" data-throw-if-not-resolved="false" data-raw-source="ResultContinuation"></xref> object to use in the next call to resume the query. </p>
name: continuationToken
type: final <xref href="com.microsoft.azure.storage.ResultContinuation?alt=com.microsoft.azure.storage.ResultContinuation&text=ResultContinuation" data-throw-if-not-resolved="False"/>
- description: <p>A <xref uid="com.microsoft.azure.storage.table.TableRequestOptions" data-throw-if-not-resolved="false" data-raw-source="TableRequestOptions"></xref> object that specifies execution options such as retry policy and timeout settings for the operation. Specify <code>null</code> to use the request options specified on the <xref uid="com.microsoft.azure.storage.table.CloudTableClient" data-throw-if-not-resolved="false" data-raw-source="CloudTableClient"></xref>. </p>
name: options
type: final <xref href="com.microsoft.azure.storage.table.TableRequestOptions?alt=com.microsoft.azure.storage.table.TableRequestOptions&text=TableRequestOptions" data-throw-if-not-resolved="False"/>
- description: <p>An <xref uid="com.microsoft.azure.storage.OperationContext" data-throw-if-not-resolved="false" data-raw-source="OperationContext"></xref> object for tracking the current operation. Specify <code>null</code> to safely ignore operation context.</p>
name: opContext
type: final <xref href="com.microsoft.azure.storage.OperationContext?alt=com.microsoft.azure.storage.OperationContext&text=OperationContext" data-throw-if-not-resolved="False"/>
exceptions:
- type: <xref href="StorageException?alt=StorageException&text=StorageException" data-throw-if-not-resolved="False"/>
description: <p>if a storage service error occurred during the operation. </p>
returns:
description: <p>A <xref uid="com.microsoft.azure.storage.ResultSegment" data-throw-if-not-resolved="false" data-raw-source="ResultSegment"></xref> of <code>String</code> objects containing table names in the storage account.</p>
type: <xref href="com.microsoft.azure.storage.ResultSegment?alt=com.microsoft.azure.storage.ResultSegment&text=ResultSegment" data-throw-if-not-resolved="False"/>&lt;String&gt;
summary: >-
<p>Lists up to the specified maximum of the table names in the storage account that match the specified prefix in a resumable mode with the specified <xref uid="com.microsoft.azure.storage.ResultContinuation" data-throw-if-not-resolved="false" data-raw-source="ResultContinuation"></xref> continuation token, using the specified <xref uid="com.microsoft.azure.storage.table.TableRequestOptions" data-throw-if-not-resolved="false" data-raw-source="TableRequestOptions"></xref> and <xref uid="com.microsoft.azure.storage.OperationContext" data-throw-if-not-resolved="false" data-raw-source="OperationContext"></xref>. This method allows listing of tables to be resumed after returning a page of results, using information returned by the server in the <xref uid="com.microsoft.azure.storage.ResultSegment" data-throw-if-not-resolved="false" data-raw-source="ResultSegment"></xref> object. </p>
<p>This method invokes the <a href="http://msdn.microsoft.com/en-us/library/azure/dd179405.aspx">Query Tables</a> REST API to list the table names that match the prefix, using the Table service endpoint and storage account credentials of this instance.</p>
<p>Use the <xref uid="com.microsoft.azure.storage.table.TableRequestOptions" data-throw-if-not-resolved="false" data-raw-source="TableRequestOptions"></xref> to override execution options such as the timeout or retry policy for the operation.</p>
<p></p>
syntax: public ResultSegment<String> listTablesSegmented(final String prefix, final Integer maxResults, final ResultContinuation continuationToken, final TableRequestOptions options, final OperationContext opContext)
uid: com.microsoft.azure.storage.table.CloudTableClient.listTablesSegmented(final String,final Integer,final ResultContinuation,final TableRequestOptions,final OperationContext)
- fullName: com.microsoft.azure.storage.table.CloudTableClient.setDefaultRequestOptions(TableRequestOptions defaultRequestOptions)
name: setDefaultRequestOptions(TableRequestOptions defaultRequestOptions)
nameWithType: CloudTableClient.setDefaultRequestOptions(TableRequestOptions defaultRequestOptions)
parameters:
- description: <p>The TableRequestOptions to use. </p>
name: defaultRequestOptions
type: <xref href="com.microsoft.azure.storage.table.TableRequestOptions?alt=com.microsoft.azure.storage.table.TableRequestOptions&text=TableRequestOptions" data-throw-if-not-resolved="False"/>
summary: >-
<p>Sets the <xref uid="com.microsoft.azure.storage.table.TableRequestOptions" data-throw-if-not-resolved="false" data-raw-source="TableRequestOptions"></xref> that is used for any table accessed with this object.</p>
<p></p>
syntax: public void setDefaultRequestOptions(TableRequestOptions defaultRequestOptions)
uid: com.microsoft.azure.storage.table.CloudTableClient.setDefaultRequestOptions(TableRequestOptions)
- fullName: com.microsoft.azure.storage.table.CloudTableClient.uploadServiceProperties(final ServiceProperties properties)
name: uploadServiceProperties(final ServiceProperties properties)
nameWithType: CloudTableClient.uploadServiceProperties(final ServiceProperties properties)
parameters:
- description: <p>The <xref uid="com.microsoft.azure.storage.ServiceProperties" data-throw-if-not-resolved="false" data-raw-source="ServiceProperties"></xref> to upload. </p>
name: properties
type: final <xref href="com.microsoft.azure.storage.ServiceProperties?alt=com.microsoft.azure.storage.ServiceProperties&text=ServiceProperties" data-throw-if-not-resolved="False"/>
exceptions:
- type: <xref href="StorageException?alt=StorageException&text=StorageException" data-throw-if-not-resolved="False"/>
description: <p>If a storage service error occurred. </p>
summary: >-
<p>Uploads a new <xref uid="com.microsoft.azure.storage.ServiceProperties" data-throw-if-not-resolved="false" data-raw-source="ServiceProperties"></xref> configuration to the given storage service. This includes Logging, HourMetrics, MinuteMetrics and CORS configurations.</p>
<p></p>
syntax: public void uploadServiceProperties(final ServiceProperties properties)
uid: com.microsoft.azure.storage.table.CloudTableClient.uploadServiceProperties(final ServiceProperties)
- fullName: com.microsoft.azure.storage.table.CloudTableClient.uploadServiceProperties(final ServiceProperties properties, TableRequestOptions options, OperationContext opContext)
name: uploadServiceProperties(final ServiceProperties properties, TableRequestOptions options, OperationContext opContext)
nameWithType: CloudTableClient.uploadServiceProperties(final ServiceProperties properties, TableRequestOptions options, OperationContext opContext)
parameters:
- description: <p>The <xref uid="com.microsoft.azure.storage.ServiceProperties" data-throw-if-not-resolved="false" data-raw-source="ServiceProperties"></xref> to upload. </p>
name: properties
type: final <xref href="com.microsoft.azure.storage.ServiceProperties?alt=com.microsoft.azure.storage.ServiceProperties&text=ServiceProperties" data-throw-if-not-resolved="False"/>
- description: <p>A <xref uid="" data-throw-if-not-resolved="false" data-raw-source="BlobRequestOptions"></xref> object that specifies any additional options for the request. Specifying <code>null</code> will use the default request options from the associated service client ( <xref uid="" data-throw-if-not-resolved="false" data-raw-source="CloudBlobClient"></xref>). </p>
name: options
type: <xref href="com.microsoft.azure.storage.table.TableRequestOptions?alt=com.microsoft.azure.storage.table.TableRequestOptions&text=TableRequestOptions" data-throw-if-not-resolved="False"/>
- description: <p>An <xref uid="com.microsoft.azure.storage.OperationContext" data-throw-if-not-resolved="false" data-raw-source="OperationContext"></xref> object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation. </p>
name: opContext
type: <xref href="com.microsoft.azure.storage.OperationContext?alt=com.microsoft.azure.storage.OperationContext&text=OperationContext" data-throw-if-not-resolved="False"/>
exceptions:
- type: <xref href="StorageException?alt=StorageException&text=StorageException" data-throw-if-not-resolved="False"/>
description: <p>If a storage service error occurred. </p>
summary: >-
<p>Uploads a new <xref uid="com.microsoft.azure.storage.ServiceProperties" data-throw-if-not-resolved="false" data-raw-source="ServiceProperties"></xref> configuration to the given storage service. This includes Logging, HourMetrics, MinuteMetrics and CORS configurations.</p>
<p></p>
syntax: public void uploadServiceProperties(final ServiceProperties properties, TableRequestOptions options, OperationContext opContext)
uid: com.microsoft.azure.storage.table.CloudTableClient.uploadServiceProperties(final ServiceProperties,TableRequestOptions,OperationContext)
2020-12-04 07:30:31 +03:00
nameWithType: CloudTableClient
syntax: public class CloudTableClient extends ServiceClient
type: class
uid: com.microsoft.azure.storage.table.CloudTableClient
fullName: com.microsoft.azure.storage.table.CloudTableClient
name: CloudTableClient
package: com.microsoft.azure.storage.table
summary: >-
<p>Provides a service client for accessing the Microsoft Azure Table service. </p>
2019-08-07 23:06:28 +03:00
2020-12-04 07:30:31 +03:00
<p>The <xref uid="com.microsoft.azure.storage.table.CloudTableClient" data-throw-if-not-resolved="false" data-raw-source="CloudTableClient"></xref> class encapsulates the base URI for the Table service endpoint and the credentials for accessing the storage account, and provides methods to create, delete, list, and query tables, as well as methods to execute operations and queries on table entities. These methods invoke Storage Service REST API operations to make the requests and obtain the results that are returned. </p>
2019-08-07 23:06:28 +03:00
2020-12-04 07:30:31 +03:00
<p>A Table service endpoint is the base URI for Table service resources, including the DNS name of the storage account: <br /><br />
2019-08-07 23:06:28 +03:00
2020-12-04 07:30:31 +03:00
For more information, see the MSDN topic <a href="http://msdn.microsoft.com/en-us/library/azure/dd179360.aspx">Addressing Table Service Resources</a>. </p>
<p>The credentials can be a combination of the storage account name and a key, or a shared access signature. For more information, see the MSDN topic <a href="http://msdn.microsoft.com/en-us/library/azure/hh225339.aspx">Authenticating Access to Your Storage Account</a>. </p>
metadata: {}