azure-docs-sdk-java/docs-ref-autogen/com.microsoft.azure.elastic...

245 строки
15 KiB
YAML

### YamlMime:JavaType
constructors:
- fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping.RangeMapping(ShardMapManager shardMapManager, RangeMappingCreationInfo creationInfo)
name: RangeMapping(ShardMapManager shardMapManager, RangeMappingCreationInfo creationInfo)
nameWithType: RangeMapping.RangeMapping(ShardMapManager shardMapManager, RangeMappingCreationInfo creationInfo)
parameters:
- description: <p>Owning ShardMapManager. </p>
name: shardMapManager
type: <xref href="com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManager?alt=com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManager&text=ShardMapManager" data-throw-if-not-resolved="False"/>
- description: <p>Mapping creation information. </p>
name: creationInfo
type: <xref href="com.microsoft.azure.elasticdb.shard.base.RangeMappingCreationInfo?alt=com.microsoft.azure.elasticdb.shard.base.RangeMappingCreationInfo&text=RangeMappingCreationInfo" data-throw-if-not-resolved="False"/>
summary: >-
<p>Constructs a range mapping given mapping creation arguments.</p>
<p></p>
syntax: public RangeMapping(ShardMapManager shardMapManager, RangeMappingCreationInfo creationInfo)
uid: com.microsoft.azure.elasticdb.shard.base.RangeMapping.RangeMapping(ShardMapManager,RangeMappingCreationInfo)
- fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping.RangeMapping(ShardMapManager shardMapManager, ShardMap shardMap, StoreMapping mapping)
name: RangeMapping(ShardMapManager shardMapManager, ShardMap shardMap, StoreMapping mapping)
nameWithType: RangeMapping.RangeMapping(ShardMapManager shardMapManager, ShardMap shardMap, StoreMapping mapping)
parameters:
- description: <p>Owning ShardMapManager. </p>
name: shardMapManager
type: <xref href="com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManager?alt=com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManager&text=ShardMapManager" data-throw-if-not-resolved="False"/>
- description: <p>Owning shard map. </p>
name: shardMap
type: <xref href="com.microsoft.azure.elasticdb.shard.map.ShardMap?alt=com.microsoft.azure.elasticdb.shard.map.ShardMap&text=ShardMap" data-throw-if-not-resolved="False"/>
- description: <p>Storage representation of the mapping. </p>
name: mapping
type: <xref href="com.microsoft.azure.elasticdb.shard.store.StoreMapping?alt=com.microsoft.azure.elasticdb.shard.store.StoreMapping&text=StoreMapping" data-throw-if-not-resolved="False"/>
summary: >-
<p>Internal constructor used for deserialization from store representation of the mapping object.</p>
<p></p>
syntax: public RangeMapping(ShardMapManager shardMapManager, ShardMap shardMap, StoreMapping mapping)
uid: com.microsoft.azure.elasticdb.shard.base.RangeMapping.RangeMapping(ShardMapManager,ShardMap,StoreMapping)
inheritances:
- <xref href="java.lang.Object" data-throw-if-not-resolved="False"/>
- <xref href="com.microsoft.azure.elasticdb.shard.base.IShardProvider?alt=com.microsoft.azure.elasticdb.shard.base.IShardProvider&text=IShardProvider%3CValueT%3E" data-throw-if-not-resolved="False"/>
methods:
- fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping.clone()
name: clone()
nameWithType: RangeMapping.clone()
returns:
description: <p>clone of the instance. </p>
type: <xref href="com.microsoft.azure.elasticdb.shard.base.RangeMapping?alt=com.microsoft.azure.elasticdb.shard.base.RangeMapping&text=RangeMapping" data-throw-if-not-resolved="False"/>
summary: >-
<p>Clones the instance which implements the interface.</p>
<p></p>
syntax: public RangeMapping clone()
uid: com.microsoft.azure.elasticdb.shard.base.RangeMapping.clone()
- fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping.equals(Object obj)
name: equals(Object obj)
nameWithType: RangeMapping.equals(Object obj)
parameters:
- description: <p>The object to compare with the current object. </p>
name: obj
type: <xref href="Object?alt=Object&text=Object" data-throw-if-not-resolved="False"/>
returns:
description: <p>True if the specified object is equal to the current object; otherwise, false. </p>
type: <xref href="boolean?alt=boolean&text=boolean" data-throw-if-not-resolved="False"/>
summary: >-
<p>Determines whether the specified object is equal to the current object.</p>
<p></p>
syntax: public boolean equals(Object obj)
uid: com.microsoft.azure.elasticdb.shard.base.RangeMapping.equals(Object)
- fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping.getId()
name: getId()
nameWithType: RangeMapping.getId()
returns:
type: <xref href="UUID?alt=UUID&text=UUID" data-throw-if-not-resolved="False"/>
summary: <p>Identity of the mapping. </p>
syntax: public UUID getId()
uid: com.microsoft.azure.elasticdb.shard.base.RangeMapping.getId()
- fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping.getKind()
name: getKind()
nameWithType: RangeMapping.getKind()
overridden: com.microsoft.azure.elasticdb.shard.base.IMappingInfoProvider.getKind()
returns:
type: <xref href="com.microsoft.azure.elasticdb.shard.base.MappingKind?alt=com.microsoft.azure.elasticdb.shard.base.MappingKind&text=MappingKind" data-throw-if-not-resolved="False"/>
summary: <p>Type of the mapping. </p>
syntax: public MappingKind getKind()
uid: com.microsoft.azure.elasticdb.shard.base.RangeMapping.getKind()
- fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping.getRange()
name: getRange()
nameWithType: RangeMapping.getRange()
returns:
type: <xref href="com.microsoft.azure.elasticdb.shard.base.ShardRange?alt=com.microsoft.azure.elasticdb.shard.base.ShardRange&text=ShardRange" data-throw-if-not-resolved="False"/>
syntax: public ShardRange getRange()
uid: com.microsoft.azure.elasticdb.shard.base.RangeMapping.getRange()
- fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping.getShard()
name: getShard()
nameWithType: RangeMapping.getShard()
returns:
type: <xref href="com.microsoft.azure.elasticdb.shard.base.Shard?alt=com.microsoft.azure.elasticdb.shard.base.Shard&text=Shard" data-throw-if-not-resolved="False"/>
summary: <p>Gets Shard that contains the range of values. </p>
syntax: public Shard getShard()
uid: com.microsoft.azure.elasticdb.shard.base.RangeMapping.getShard()
- fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping.getShardInfo()
name: getShardInfo()
nameWithType: RangeMapping.getShardInfo()
returns:
type: <xref href="com.microsoft.azure.elasticdb.shard.base.Shard?alt=com.microsoft.azure.elasticdb.shard.base.Shard&text=Shard" data-throw-if-not-resolved="False"/>
summary: <p>Shard that contains the range of values. </p>
syntax: public Shard getShardInfo()
uid: com.microsoft.azure.elasticdb.shard.base.RangeMapping.getShardInfo()
- fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping.getShardMapId()
name: getShardMapId()
nameWithType: RangeMapping.getShardMapId()
overridden: com.microsoft.azure.elasticdb.shard.base.IMappingInfoProvider.getShardMapId()
returns:
type: <xref href="UUID?alt=UUID&text=UUID" data-throw-if-not-resolved="False"/>
summary: <p>Identify of the ShardMap this shard belongs to. </p>
syntax: public UUID getShardMapId()
uid: com.microsoft.azure.elasticdb.shard.base.RangeMapping.getShardMapId()
- fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping.getShardMapManager()
name: getShardMapManager()
nameWithType: RangeMapping.getShardMapManager()
overridden: com.microsoft.azure.elasticdb.shard.base.IMappingInfoProvider.getShardMapManager()
returns:
type: <xref href="com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManager?alt=com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManager&text=ShardMapManager" data-throw-if-not-resolved="False"/>
summary: <p>ShardMapManager for the object. </p>
syntax: public ShardMapManager getShardMapManager()
uid: com.microsoft.azure.elasticdb.shard.base.RangeMapping.getShardMapManager()
- fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping.getStatus()
name: getStatus()
nameWithType: RangeMapping.getStatus()
returns:
type: <xref href="com.microsoft.azure.elasticdb.shard.base.MappingStatus?alt=com.microsoft.azure.elasticdb.shard.base.MappingStatus&text=MappingStatus" data-throw-if-not-resolved="False"/>
summary: <p>Gets the <xref uid="com.microsoft.azure.elasticdb.shard.base.MappingStatus" data-throw-if-not-resolved="false" data-raw-source="MappingStatus"></xref> of the mapping. </p>
syntax: public MappingStatus getStatus()
uid: com.microsoft.azure.elasticdb.shard.base.RangeMapping.getStatus()
- fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping.getStoreMapping()
name: getStoreMapping()
nameWithType: RangeMapping.getStoreMapping()
overridden: com.microsoft.azure.elasticdb.shard.base.IMappingInfoProvider.getStoreMapping()
returns:
type: <xref href="com.microsoft.azure.elasticdb.shard.store.StoreMapping?alt=com.microsoft.azure.elasticdb.shard.store.StoreMapping&text=StoreMapping" data-throw-if-not-resolved="False"/>
summary: <p>Storage representation of the mapping. </p>
syntax: public StoreMapping getStoreMapping()
uid: com.microsoft.azure.elasticdb.shard.base.RangeMapping.getStoreMapping()
- fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping.getTypeName()
name: getTypeName()
nameWithType: RangeMapping.getTypeName()
overridden: com.microsoft.azure.elasticdb.shard.base.IMappingInfoProvider.getTypeName()
returns:
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
summary: <p>Mapping type, useful for diagnostics. </p>
syntax: public String getTypeName()
uid: com.microsoft.azure.elasticdb.shard.base.RangeMapping.getTypeName()
- fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping.getValue()
name: getValue()
nameWithType: RangeMapping.getValue()
returns:
type: <xref href="com.microsoft.azure.elasticdb.shard.base.Range?alt=com.microsoft.azure.elasticdb.shard.base.Range&text=Range" data-throw-if-not-resolved="False"/>
syntax: public Range getValue()
uid: com.microsoft.azure.elasticdb.shard.base.RangeMapping.getValue()
- fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping.hashCode()
name: hashCode()
nameWithType: RangeMapping.hashCode()
returns:
description: <p>Hash code for the object. </p>
type: <xref href="int?alt=int&text=int" data-throw-if-not-resolved="False"/>
summary: >-
<p>Calculates the hash code for this instance.</p>
<p></p>
syntax: public int hashCode()
uid: com.microsoft.azure.elasticdb.shard.base.RangeMapping.hashCode()
- fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping.setRange(ShardRange value)
name: setRange(ShardRange value)
nameWithType: RangeMapping.setRange(ShardRange value)
parameters:
- name: value
type: <xref href="com.microsoft.azure.elasticdb.shard.base.ShardRange?alt=com.microsoft.azure.elasticdb.shard.base.ShardRange&text=ShardRange" data-throw-if-not-resolved="False"/>
syntax: public void setRange(ShardRange value)
uid: com.microsoft.azure.elasticdb.shard.base.RangeMapping.setRange(ShardRange)
- fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping.setShardMapManager(ShardMapManager value)
name: setShardMapManager(ShardMapManager value)
nameWithType: RangeMapping.setShardMapManager(ShardMapManager value)
parameters:
- name: value
type: <xref href="com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManager?alt=com.microsoft.azure.elasticdb.shard.mapmanager.ShardMapManager&text=ShardMapManager" data-throw-if-not-resolved="False"/>
syntax: public void setShardMapManager(ShardMapManager value)
uid: com.microsoft.azure.elasticdb.shard.base.RangeMapping.setShardMapManager(ShardMapManager)
- fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping.toString()
name: toString()
nameWithType: RangeMapping.toString()
returns:
description: <p>String representation of the object. </p>
type: <xref href="String?alt=String&text=String" data-throw-if-not-resolved="False"/>
summary: >-
<p>Converts the object to its string representation.</p>
<p></p>
syntax: public String toString()
uid: com.microsoft.azure.elasticdb.shard.base.RangeMapping.toString()
- fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping.validate(StoreShardMap shardMap, Connection conn)
name: validate(StoreShardMap shardMap, Connection conn)
nameWithType: RangeMapping.validate(StoreShardMap shardMap, Connection conn)
parameters:
- description: <p>Shard map to which the shard provider belongs. </p>
name: shardMap
type: <xref href="com.microsoft.azure.elasticdb.shard.store.StoreShardMap?alt=com.microsoft.azure.elasticdb.shard.store.StoreShardMap&text=StoreShardMap" data-throw-if-not-resolved="False"/>
- description: <p>Connection used for validation. </p>
name: conn
type: <xref href="Connection?alt=Connection&text=Connection" data-throw-if-not-resolved="False"/>
summary: >-
<p>Performs validation that the local representation is as up-to-date as the representation on the backing data store.</p>
<p></p>
syntax: public void validate(StoreShardMap shardMap, Connection conn)
uid: com.microsoft.azure.elasticdb.shard.base.RangeMapping.validate(StoreShardMap,Connection)
- fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping.validateAsync(StoreShardMap shardMap, Connection conn)
name: validateAsync(StoreShardMap shardMap, Connection conn)
nameWithType: RangeMapping.validateAsync(StoreShardMap shardMap, Connection conn)
parameters:
- description: <p>Shard map to which the shard provider belongs. </p>
name: shardMap
type: <xref href="com.microsoft.azure.elasticdb.shard.store.StoreShardMap?alt=com.microsoft.azure.elasticdb.shard.store.StoreShardMap&text=StoreShardMap" data-throw-if-not-resolved="False"/>
- description: <p>Connection used for validation. </p>
name: conn
type: <xref href="Connection?alt=Connection&text=Connection" data-throw-if-not-resolved="False"/>
returns:
description: <p>A task to await validation completion </p>
type: <xref href="Callable?alt=Callable&text=Callable" data-throw-if-not-resolved="False"/>
summary: >-
<p>Asynchronously performs validation that the local representation is as up-to-date as the representation on the backing data store.</p>
<p></p>
syntax: public Callable validateAsync(StoreShardMap shardMap, Connection conn)
uid: com.microsoft.azure.elasticdb.shard.base.RangeMapping.validateAsync(StoreShardMap,Connection)
nameWithType: RangeMapping
syntax: public class RangeMapping implements IShardProvider<Range>,IMappingInfoProvider
type: class
uid: com.microsoft.azure.elasticdb.shard.base.RangeMapping
fullName: com.microsoft.azure.elasticdb.shard.base.RangeMapping
name: RangeMapping
package: com.microsoft.azure.elasticdb.shard.base
summary: <p>Represents a mapping between a range of key values and a <xref uid="com.microsoft.azure.elasticdb.shard.base.Shard" data-throw-if-not-resolved="false" data-raw-source="Shard"></xref>. </p>
metadata: {}