246 строки
17 KiB
YAML
246 строки
17 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.sql.models.JobTarget"
|
|
fullName: "com.azure.resourcemanager.sql.models.JobTarget"
|
|
name: "JobTarget"
|
|
nameWithType: "JobTarget"
|
|
summary: "A job target, for example a specific database or a container of databases that is evaluated during job execution."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **JobTarget**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.sql.models.JobTarget?alt=com.azure.resourcemanager.sql.models.JobTarget&text=JobTarget\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.resourcemanager.sql.models.JobTarget.JobTarget()"
|
|
fullName: "com.azure.resourcemanager.sql.models.JobTarget.JobTarget()"
|
|
name: "JobTarget()"
|
|
nameWithType: "JobTarget.JobTarget()"
|
|
summary: "Creates an instance of Job<wbr>Target class."
|
|
syntax: "public JobTarget()"
|
|
desc: "Creates an instance of JobTarget class."
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.sql.models.JobTarget.databaseName()"
|
|
fullName: "com.azure.resourcemanager.sql.models.JobTarget.databaseName()"
|
|
name: "databaseName()"
|
|
nameWithType: "JobTarget.databaseName()"
|
|
summary: "Get the database<wbr>Name property: The target database name."
|
|
syntax: "public String databaseName()"
|
|
desc: "Get the databaseName property: The target database name."
|
|
returns:
|
|
description: "the databaseName value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.sql.models.JobTarget.elasticPoolName()"
|
|
fullName: "com.azure.resourcemanager.sql.models.JobTarget.elasticPoolName()"
|
|
name: "elasticPoolName()"
|
|
nameWithType: "JobTarget.elasticPoolName()"
|
|
summary: "Get the elastic<wbr>Pool<wbr>Name property: The target elastic pool name."
|
|
syntax: "public String elasticPoolName()"
|
|
desc: "Get the elasticPoolName property: The target elastic pool name."
|
|
returns:
|
|
description: "the elasticPoolName value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.sql.models.JobTarget.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.resourcemanager.sql.models.JobTarget.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "JobTarget.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of Job<wbr>Target from the Json<wbr>Reader."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The JsonReader being read."
|
|
name: "jsonReader"
|
|
type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static JobTarget fromJson(JsonReader jsonReader)"
|
|
exceptions:
|
|
- description: "If the deserialized JSON object was missing any required properties."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reads an instance of JobTarget from the JsonReader."
|
|
returns:
|
|
description: "An instance of JobTarget if the JsonReader was pointing to an instance of it, or null if it was pointing\n to JSON null."
|
|
type: "<xref href=\"com.azure.resourcemanager.sql.models.JobTarget?alt=com.azure.resourcemanager.sql.models.JobTarget&text=JobTarget\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.sql.models.JobTarget.membershipType()"
|
|
fullName: "com.azure.resourcemanager.sql.models.JobTarget.membershipType()"
|
|
name: "membershipType()"
|
|
nameWithType: "JobTarget.membershipType()"
|
|
summary: "Get the membership<wbr>Type property: Whether the target is included or excluded from the group."
|
|
syntax: "public JobTargetGroupMembershipType membershipType()"
|
|
desc: "Get the membershipType property: Whether the target is included or excluded from the group."
|
|
returns:
|
|
description: "the membershipType value."
|
|
type: "<xref href=\"com.azure.resourcemanager.sql.models.JobTargetGroupMembershipType?alt=com.azure.resourcemanager.sql.models.JobTargetGroupMembershipType&text=JobTargetGroupMembershipType\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.sql.models.JobTarget.refreshCredential()"
|
|
fullName: "com.azure.resourcemanager.sql.models.JobTarget.refreshCredential()"
|
|
name: "refreshCredential()"
|
|
nameWithType: "JobTarget.refreshCredential()"
|
|
summary: "Get the refresh<wbr>Credential property: The resource ID of the credential that is used during job execution to connect to the target and determine the list of databases inside the target."
|
|
syntax: "public String refreshCredential()"
|
|
desc: "Get the refreshCredential property: The resource ID of the credential that is used during job execution to connect to the target and determine the list of databases inside the target."
|
|
returns:
|
|
description: "the refreshCredential value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.sql.models.JobTarget.serverName()"
|
|
fullName: "com.azure.resourcemanager.sql.models.JobTarget.serverName()"
|
|
name: "serverName()"
|
|
nameWithType: "JobTarget.serverName()"
|
|
summary: "Get the server<wbr>Name property: The target server name."
|
|
syntax: "public String serverName()"
|
|
desc: "Get the serverName property: The target server name."
|
|
returns:
|
|
description: "the serverName value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.sql.models.JobTarget.shardMapName()"
|
|
fullName: "com.azure.resourcemanager.sql.models.JobTarget.shardMapName()"
|
|
name: "shardMapName()"
|
|
nameWithType: "JobTarget.shardMapName()"
|
|
summary: "Get the shard<wbr>Map<wbr>Name property: The target shard map."
|
|
syntax: "public String shardMapName()"
|
|
desc: "Get the shardMapName property: The target shard map."
|
|
returns:
|
|
description: "the shardMapName value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.sql.models.JobTarget.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.resourcemanager.sql.models.JobTarget.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "JobTarget.toJson(JsonWriter jsonWriter)"
|
|
parameters:
|
|
- name: "jsonWriter"
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
|
|
exceptions:
|
|
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
returns:
|
|
type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.sql.models.JobTarget.type()"
|
|
fullName: "com.azure.resourcemanager.sql.models.JobTarget.type()"
|
|
name: "type()"
|
|
nameWithType: "JobTarget.type()"
|
|
summary: "Get the type property: The target type."
|
|
syntax: "public JobTargetType type()"
|
|
desc: "Get the type property: The target type."
|
|
returns:
|
|
description: "the type value."
|
|
type: "<xref href=\"com.azure.resourcemanager.sql.models.JobTargetType?alt=com.azure.resourcemanager.sql.models.JobTargetType&text=JobTargetType\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.sql.models.JobTarget.validate()"
|
|
fullName: "com.azure.resourcemanager.sql.models.JobTarget.validate()"
|
|
name: "validate()"
|
|
nameWithType: "JobTarget.validate()"
|
|
summary: "Validates the instance."
|
|
syntax: "public void validate()"
|
|
desc: "Validates the instance."
|
|
- uid: "com.azure.resourcemanager.sql.models.JobTarget.withDatabaseName(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.sql.models.JobTarget.withDatabaseName(String databaseName)"
|
|
name: "withDatabaseName(String databaseName)"
|
|
nameWithType: "JobTarget.withDatabaseName(String databaseName)"
|
|
summary: "Set the database<wbr>Name property: The target database name."
|
|
parameters:
|
|
- description: "the databaseName value to set."
|
|
name: "databaseName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public JobTarget withDatabaseName(String databaseName)"
|
|
desc: "Set the databaseName property: The target database name."
|
|
returns:
|
|
description: "the JobTarget object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.sql.models.JobTarget?alt=com.azure.resourcemanager.sql.models.JobTarget&text=JobTarget\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.sql.models.JobTarget.withElasticPoolName(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.sql.models.JobTarget.withElasticPoolName(String elasticPoolName)"
|
|
name: "withElasticPoolName(String elasticPoolName)"
|
|
nameWithType: "JobTarget.withElasticPoolName(String elasticPoolName)"
|
|
summary: "Set the elastic<wbr>Pool<wbr>Name property: The target elastic pool name."
|
|
parameters:
|
|
- description: "the elasticPoolName value to set."
|
|
name: "elasticPoolName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public JobTarget withElasticPoolName(String elasticPoolName)"
|
|
desc: "Set the elasticPoolName property: The target elastic pool name."
|
|
returns:
|
|
description: "the JobTarget object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.sql.models.JobTarget?alt=com.azure.resourcemanager.sql.models.JobTarget&text=JobTarget\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.sql.models.JobTarget.withMembershipType(com.azure.resourcemanager.sql.models.JobTargetGroupMembershipType)"
|
|
fullName: "com.azure.resourcemanager.sql.models.JobTarget.withMembershipType(JobTargetGroupMembershipType membershipType)"
|
|
name: "withMembershipType(JobTargetGroupMembershipType membershipType)"
|
|
nameWithType: "JobTarget.withMembershipType(JobTargetGroupMembershipType membershipType)"
|
|
summary: "Set the membership<wbr>Type property: Whether the target is included or excluded from the group."
|
|
parameters:
|
|
- description: "the membershipType value to set."
|
|
name: "membershipType"
|
|
type: "<xref href=\"com.azure.resourcemanager.sql.models.JobTargetGroupMembershipType?alt=com.azure.resourcemanager.sql.models.JobTargetGroupMembershipType&text=JobTargetGroupMembershipType\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public JobTarget withMembershipType(JobTargetGroupMembershipType membershipType)"
|
|
desc: "Set the membershipType property: Whether the target is included or excluded from the group."
|
|
returns:
|
|
description: "the JobTarget object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.sql.models.JobTarget?alt=com.azure.resourcemanager.sql.models.JobTarget&text=JobTarget\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.sql.models.JobTarget.withRefreshCredential(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.sql.models.JobTarget.withRefreshCredential(String refreshCredential)"
|
|
name: "withRefreshCredential(String refreshCredential)"
|
|
nameWithType: "JobTarget.withRefreshCredential(String refreshCredential)"
|
|
summary: "Set the refresh<wbr>Credential property: The resource ID of the credential that is used during job execution to connect to the target and determine the list of databases inside the target."
|
|
parameters:
|
|
- description: "the refreshCredential value to set."
|
|
name: "refreshCredential"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public JobTarget withRefreshCredential(String refreshCredential)"
|
|
desc: "Set the refreshCredential property: The resource ID of the credential that is used during job execution to connect to the target and determine the list of databases inside the target."
|
|
returns:
|
|
description: "the JobTarget object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.sql.models.JobTarget?alt=com.azure.resourcemanager.sql.models.JobTarget&text=JobTarget\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.sql.models.JobTarget.withServerName(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.sql.models.JobTarget.withServerName(String serverName)"
|
|
name: "withServerName(String serverName)"
|
|
nameWithType: "JobTarget.withServerName(String serverName)"
|
|
summary: "Set the server<wbr>Name property: The target server name."
|
|
parameters:
|
|
- description: "the serverName value to set."
|
|
name: "serverName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public JobTarget withServerName(String serverName)"
|
|
desc: "Set the serverName property: The target server name."
|
|
returns:
|
|
description: "the JobTarget object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.sql.models.JobTarget?alt=com.azure.resourcemanager.sql.models.JobTarget&text=JobTarget\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.sql.models.JobTarget.withShardMapName(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.sql.models.JobTarget.withShardMapName(String shardMapName)"
|
|
name: "withShardMapName(String shardMapName)"
|
|
nameWithType: "JobTarget.withShardMapName(String shardMapName)"
|
|
summary: "Set the shard<wbr>Map<wbr>Name property: The target shard map."
|
|
parameters:
|
|
- description: "the shardMapName value to set."
|
|
name: "shardMapName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public JobTarget withShardMapName(String shardMapName)"
|
|
desc: "Set the shardMapName property: The target shard map."
|
|
returns:
|
|
description: "the JobTarget object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.sql.models.JobTarget?alt=com.azure.resourcemanager.sql.models.JobTarget&text=JobTarget\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.sql.models.JobTarget.withType(com.azure.resourcemanager.sql.models.JobTargetType)"
|
|
fullName: "com.azure.resourcemanager.sql.models.JobTarget.withType(JobTargetType type)"
|
|
name: "withType(JobTargetType type)"
|
|
nameWithType: "JobTarget.withType(JobTargetType type)"
|
|
summary: "Set the type property: The target type."
|
|
parameters:
|
|
- description: "the type value to set."
|
|
name: "type"
|
|
type: "<xref href=\"com.azure.resourcemanager.sql.models.JobTargetType?alt=com.azure.resourcemanager.sql.models.JobTargetType&text=JobTargetType\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public JobTarget withType(JobTargetType type)"
|
|
desc: "Set the type property: The target type."
|
|
returns:
|
|
description: "the JobTarget object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.sql.models.JobTarget?alt=com.azure.resourcemanager.sql.models.JobTarget&text=JobTarget\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "A job target, for example a specific database or a container of databases that is evaluated during job execution."
|
|
implements:
|
|
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.sql.models.JobTarget?alt=com.azure.resourcemanager.sql.models.JobTarget&text=JobTarget\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.sql.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-sql:2.42.0
|