ServiceClient (Microsoft Azure Storage Client SDK 2.2.0 API)

java.lang.Object
- com.microsoft.azure.storage.ServiceClient

Direct Known Subclasses:

CloudBlobClient, CloudFileClient, CloudQueueClient, CloudTableClient
```
public abstract class ServiceClient
extends Object
```
Provides a client for accessing the Microsoft Azure Storage service.

Field Summary

Fields
Modifier and Type	Field and Description
`protected AuthenticationScheme`	`authenticationScheme` Holds the AuthenticationScheme associated with this Service Client.
`protected StorageCredentials`	`credentials` Holds the StorageCredentials associated with this Service Client.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ServiceClient(StorageUri storageUri, StorageCredentials credentials)` Creates an instance of the `ServiceClient` class using the specified service endpoint and account credentials.

Method Summary

Methods
Modifier and Type	Method and Description
`protected StorageRequest<ServiceClient,Void,ServiceProperties>`	`downloadServicePropertiesImpl(RequestOptions options, boolean signAsTable)`
`AuthenticationScheme`	`getAuthenticationScheme()` Deprecated. as of 2.0.0. In the future only SharedKeyFull will be used.
`StorageCredentials`	`getCredentials()` Returns the storage credentials associated with this service client.
`abstract RequestOptions`	`getDefaultRequestOptions()` Gets the `RequestOptions` that is used for requests associated with this `ServiceClient`
`URI`	`getEndpoint()` Returns the base URI for this service client.
`LocationMode`	`getLocationMode()` Deprecated. use `#getDefaultRequestOptions().getLocationMode()` instead.
`Integer`	`getMaximumExecutionTimeInMs()` Deprecated. use `#getDefaultRequestOptions().getMaximumExecutionTimeInMs()` instead.
`RetryPolicyFactory`	`getRetryPolicyFactory()` Deprecated. use `#getDefaultRequestOptions().getRetryPolicyFactory()` instead.
`protected StorageRequest<ServiceClient,Void,ServiceStats>`	`getServiceStatsImpl(RequestOptions options, boolean signAsTable)`
`StorageUri`	`getStorageUri()` Returns the list of URIs for all locations.
`int`	`getTimeoutInMs()` Deprecated. use `#getDefaultRequestOptions().getTimeoutIntervalInMs()` instead.
`protected boolean`	`isUsePathStyleUris()`
`void`	`setAuthenticationScheme(AuthenticationScheme scheme)` Deprecated. as of 2.0.0. In the future, only SharedKeyFull will be used.
`protected void`	`setCredentials(StorageCredentials credentials)` Sets the credentials to use with this service client.
`void`	`setLocationMode(LocationMode locationMode)` Deprecated. use `#getDefaultRequestOptions().setLocationMode()` instead.
`void`	`setMaximumExecutionTimeInMs(Integer maximumExecutionTimeInMs)` Deprecated. use `#getDefaultRequestOptions().setMaximumExecutionTimeInMs()` instead.
`void`	`setRetryPolicyFactory(RetryPolicyFactory retryPolicyFactory)` Deprecated. use `#getDefaultRequestOptions().setRetryPolicyFactory()` instead.
`protected void`	`setStorageUri(StorageUri storageUri)` Sets the list of URIs for all locations.
`void`	`setTimeoutInMs(int timeoutInMs)` Deprecated. use `#getDefaultRequestOptions().setTimeoutIntervalInMs()` instead.
`protected StorageRequest<ServiceClient,Void,Void>`	`uploadServicePropertiesImpl(ServiceProperties properties, RequestOptions options, OperationContext opContext, boolean signAsTable)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - credentials
```
protected StorageCredentials credentials
```
    Holds the StorageCredentials associated with this Service Client.
  - authenticationScheme
```
protected AuthenticationScheme authenticationScheme
```
    Holds the AuthenticationScheme associated with this Service Client.
- Constructor Detail
  - ServiceClient
```
protected ServiceClient(StorageUri storageUri,
             StorageCredentials credentials)
```
    Creates an instance of the ServiceClient class using the specified service endpoint and account credentials.
    
    Parameters:
    storageUri - A StorageUri object which represents the service endpoint used to create the client.
    credentials - A StorageCredentials object which represents the account credentials.
- Method Detail
  - downloadServicePropertiesImpl
```
protected StorageRequest<ServiceClient,Void,ServiceProperties> downloadServicePropertiesImpl(RequestOptions options,
                                                                                 boolean signAsTable)
```
  - getServiceStatsImpl
```
protected StorageRequest<ServiceClient,Void,ServiceStats> getServiceStatsImpl(RequestOptions options,
                                                                  boolean signAsTable)
```
  - getCredentials
```
public final StorageCredentials getCredentials()
```
    Returns the storage credentials associated with this service client.
    
    Returns:
    A StorageCredentials object which represents the storage credentials associated with this client.
  - getAuthenticationScheme
```
public final AuthenticationScheme getAuthenticationScheme()
```
    Deprecated. as of 2.0.0. In the future only SharedKeyFull will be used.
    
    Returns the AuthenticationScheme associated with this service client.
    
    Returns:
    An AuthenticationScheme object which represents the authentication scheme associated with this client.
  - getEndpoint
```
public final URI getEndpoint()
```
    Returns the base URI for this service client.
    
    Returns:
    A java.net.URI object which represents the base URI for the service client.
  - getStorageUri
```
public final StorageUri getStorageUri()
```
    Returns the list of URIs for all locations.
    
    Returns:
    A StorageUri object which represents the list of URIs for all locations.
  - isUsePathStyleUris
```
protected boolean isUsePathStyleUris()
```
    Returns:
    true if path-style URIs are used; otherwise, false.
  - setCredentials
```
protected final void setCredentials(StorageCredentials credentials)
```
    Sets the credentials to use with this service client.
    
    Parameters:
    credentials - A StorageCredentials object which represents the credentials being assigned for the service client.
  - setStorageUri
```
protected final void setStorageUri(StorageUri storageUri)
```
    Sets the list of URIs for all locations.
    
    Parameters:
    storageUri - A StorageUri object which represents the list of URIs for all locations.
  - setAuthenticationScheme
```
public final void setAuthenticationScheme(AuthenticationScheme scheme)
```
    Deprecated. as of 2.0.0. In the future, only SharedKeyFull will be used.
    
    Sets the Authentication Scheme to use with this service client.
    
    Parameters:
    scheme - An AuthenticationScheme object which represents the authentication scheme being assigned for the service client.
  - uploadServicePropertiesImpl
```
protected StorageRequest<ServiceClient,Void,Void> uploadServicePropertiesImpl(ServiceProperties properties,
                                                                  RequestOptions options,
                                                                  OperationContext opContext,
                                                                  boolean signAsTable)
                                                                       throws StorageException
```
    Throws:
    
    StorageException
  - getLocationMode
```
@Deprecated
public final LocationMode getLocationMode()
```
    Deprecated. use #getDefaultRequestOptions().getLocationMode() instead.
    
    Gets the default location mode for requests made via the service client.
    
    Returns:
    A LocationMode object which represents the default location mode for the service client.
  - getRetryPolicyFactory
```
@Deprecated
public final RetryPolicyFactory getRetryPolicyFactory()
```
    Deprecated. use #getDefaultRequestOptions().getRetryPolicyFactory() instead.
    
    Returns the retry policy currently in effect for this service client.
    
    Returns:
    An RetryPolicyFactory object which represents the current retry policy.
    See Also:
    RetryPolicy, RetryExponentialRetry, RetryLinearRetry, RetryNoRetry
  - getTimeoutInMs
```
@Deprecated
public final int getTimeoutInMs()
```
    Deprecated. use #getDefaultRequestOptions().getTimeoutIntervalInMs() instead.
    
    Returns the timeout value for requests made to the service. For more information about the timeout, see setTimeoutInMs(int).
    
    Returns:
    The current timeout value, in milliseconds, for requests made to the storage service.
  - getMaximumExecutionTimeInMs
```
@Deprecated
public Integer getMaximumExecutionTimeInMs()
```
    Deprecated. use #getDefaultRequestOptions().getMaximumExecutionTimeInMs() instead.
    
    Returns the maximum execution time, in milliseconds, across all potential retries. For more information about maximum execution time, see setMaximumExecutionTimeInMs(Integer).
    
    Returns:
    The maximum execution time, in milliseconds, for requests made to the storage service.
  - setLocationMode
```
@Deprecated
public void setLocationMode(LocationMode locationMode)
```
    Deprecated. use #getDefaultRequestOptions().setLocationMode() instead.
    
    Sets the default LocationMode for requests made via the service client.
    
    Parameters:
    locationMode - the locationMode to set
  - setRetryPolicyFactory
```
@Deprecated
public void setRetryPolicyFactory(RetryPolicyFactory retryPolicyFactory)
```
    Deprecated. use #getDefaultRequestOptions().setRetryPolicyFactory() instead.
    
    Sets the RetryPolicyFactory object to use when making service requests.
    
    Parameters:
    retryPolicyFactory - the RetryPolicyFactory object to use when making service requests.
  - setTimeoutInMs
```
@Deprecated
public final void setTimeoutInMs(int timeoutInMs)
```
    Deprecated. use #getDefaultRequestOptions().setTimeoutIntervalInMs() instead.
    
    Sets the timeout to use when making requests to the storage service.
    The server timeout interval begins at the time that the complete request has been received by the service, and the server begins processing the response. If the timeout interval elapses before the response is returned to the client, the operation times out. The timeout interval resets with each retry, if the request is retried. You can change this value on the service client by setting this property, so that all subsequent requests made via the service client will use the new timeout interval. You can also change this value for an individual request, by setting the RequestOptions.setTimeoutIntervalInMs(Integer) property.
    
    Parameters:
    timeoutInMs - The timeout, in milliseconds, to use when making requests to the storage service.
  - setMaximumExecutionTimeInMs
```
@Deprecated
public void setMaximumExecutionTimeInMs(Integer maximumExecutionTimeInMs)
```
    Deprecated. use #getDefaultRequestOptions().setMaximumExecutionTimeInMs() instead.
    
    Sets the maximum execution time to use when making requests to the storage service.
    The maximum execution time interval begins at the time that the client begins building the request. The maximum execution time is checked intermittently while uploading data, downloading data, and before executing retries. The service will continue to upload, download, and retry until the maximum execution time is reached. At that time, any partial uploads or downloads will be cancelled and an exception will be thrown. The default maximum execution time is null, indicating no maximum time. You can change this value on the service client by setting this property, so that all subsequent requests made via the service client will use the new maximum execution time. You can also change this value for an individual request, by setting the RequestOptions.setMaximumExecutionTimeInMs(Integer) property.
    
    Parameters:
    maximumExecutionTimeInMs - The maximum execution time, in milliseconds, to use when making service requests.
  - getDefaultRequestOptions
```
public abstract RequestOptions getDefaultRequestOptions()
```
    Gets the RequestOptions that is used for requests associated with this ServiceClient
    
    Returns:
    The RequestOptions object containing the values used by this ServiceClient

/** 
* Copyright Microsoft Corporation 
* 
* Licensed under the Apache License, Version 2.0 (the "License"); 
* you may not use this file except in compliance with the License. 
* You may obtain a copy of the License at 
* http://www.apache.org/licenses/LICENSE-2.0 
* 
* Unless required by applicable law or agreed to in writing, software 
* distributed under the License is distributed on an "AS IS" BASIS, 
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
* See the License for the specific language governing permissions and 
* limitations under the License. 
*/

Class ServiceClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

credentials

authenticationScheme

Constructor Detail

ServiceClient

Method Detail

downloadServicePropertiesImpl

getServiceStatsImpl

getCredentials

getAuthenticationScheme

getEndpoint

getStorageUri

isUsePathStyleUris

setCredentials

setStorageUri

setAuthenticationScheme

uploadServicePropertiesImpl

getLocationMode

getRetryPolicyFactory

getTimeoutInMs

getMaximumExecutionTimeInMs

setLocationMode

setRetryPolicyFactory

setTimeoutInMs

setMaximumExecutionTimeInMs

getDefaultRequestOptions