JobTarget Class

Package:

com.microsoft.azure.management.sql

• java.lang.Object
• • com.microsoft.azure.management.sql.JobTarget

public class JobTarget

A job target, for example a specific database or a container of databases that is evaluated during job execution.

Method Summary

Modifier and Type	Method and Description
String	databaseName() Get the target database name.
String	elasticPoolName() Get the target elastic pool name.
JobTargetGroupMembershipType	membershipType() Get whether the target is included or excluded from the group. Possible values include: 'Include', 'Exclude'.
String	refreshCredential() Get 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.
String	serverName() Get the target server name.
String	shardMapName() Get the target shard map.
JobTargetType	type() Get the target type. Possible values include: 'TargetGroup', 'SqlDatabase', 'SqlElasticPool', 'SqlShardMap', 'SqlServer'.
JobTarget	withDatabaseName(String databaseName) Set the target database name.
JobTarget	withElasticPoolName(String elasticPoolName) Set the target elastic pool name.
JobTarget	withMembershipType(JobTargetGroupMembershipType membershipType) Set whether the target is included or excluded from the group. Possible values include: 'Include', 'Exclude'.
JobTarget	withRefreshCredential(String refreshCredential) Set 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.
JobTarget	withServerName(String serverName) Set the target server name.
JobTarget	withShardMapName(String shardMapName) Set the target shard map.
JobTarget	withType(JobTargetType type) Set the target type. Possible values include: 'TargetGroup', 'SqlDatabase', 'SqlElasticPool', 'SqlShardMap', 'SqlServer'.

Method Details

databaseName

public String databaseName()

Get the target database name.

Returns:

the databaseName value

elasticPoolName

public String elasticPoolName()

Get the target elastic pool name.

Returns:

the elasticPoolName value

membershipType

public JobTargetGroupMembershipType membershipType()

Get whether the target is included or excluded from the group. Possible values include: 'Include', 'Exclude'.

Returns:

the membershipType value

refreshCredential

public String refreshCredential()

Get 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:

the refreshCredential value

serverName

public String serverName()

Get the target server name.

Returns:

the serverName value

shardMapName

public String shardMapName()

Get the target shard map.

Returns:

the shardMapName value

type

public JobTargetType type()

Get the target type. Possible values include: 'TargetGroup', 'SqlDatabase', 'SqlElasticPool', 'SqlShardMap', 'SqlServer'.

Returns:

the type value

withDatabaseName

public JobTarget withDatabaseName(String databaseName)

Set the target database name.

Parameters:

databaseName - the databaseName value to set

Returns:

the JobTarget object itself.

withElasticPoolName

public JobTarget withElasticPoolName(String elasticPoolName)

Set the target elastic pool name.

Parameters:

elasticPoolName - the elasticPoolName value to set

Returns:

the JobTarget object itself.

withMembershipType

public JobTarget withMembershipType(JobTargetGroupMembershipType membershipType)

Set whether the target is included or excluded from the group. Possible values include: 'Include', 'Exclude'.

Parameters:

membershipType - the membershipType value to set

Returns:

the JobTarget object itself.

withRefreshCredential

public JobTarget withRefreshCredential(String refreshCredential)

Set 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:

refreshCredential - the refreshCredential value to set

Returns:

the JobTarget object itself.

withServerName

public JobTarget withServerName(String serverName)

Set the target server name.

Parameters:

serverName - the serverName value to set

Returns:

the JobTarget object itself.

withShardMapName

public JobTarget withShardMapName(String shardMapName)

Set the target shard map.

Parameters:

shardMapName - the shardMapName value to set

Returns:

the JobTarget object itself.

withType

public JobTarget withType(JobTargetType type)

Set the target type. Possible values include: 'TargetGroup', 'SqlDatabase', 'SqlElasticPool', 'SqlShardMap', 'SqlServer'.

Parameters:

type - the type value to set

Returns:

the JobTarget object itself.