com.azure.resourcemanager.postgresqlflexibleserver.models

Interface Server

public interface Server

An immutable client-side representation of Server.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Server.Definition The entirety of the Server definition.
static interface	Server.DefinitionStages The Server definition stages.
static interface	Server.Update The template for Server update.
static interface	Server.UpdateStages The Server update stages.

Method Summary

Modifier and Type	Method and Description
String	administratorLogin() Gets the administratorLogin property: The administrator's login name of a server.
String	administratorLoginPassword() Gets the administratorLoginPassword property: The administrator login password (required for server creation).
String	availabilityZone() Gets the availabilityZone property: availability zone information of the server.
Backup	backup() Gets the backup property: Backup properties of a server.
CreateMode	createMode() Gets the createMode property: The mode to create a new PostgreSQL server.
String	fullyQualifiedDomainName() Gets the fullyQualifiedDomainName property: The fully qualified domain name of a server.
HighAvailability	highAvailability() Gets the highAvailability property: High availability properties of a server.
String	id() Gets the id property: Fully qualified resource Id for the resource.
ServerInner	innerModel() Gets the inner com.azure.resourcemanager.postgresqlflexibleserver.fluent.models.ServerInner object.
String	location() Gets the location property: The geo-location where the resource lives.
MaintenanceWindow	maintenanceWindow() Gets the maintenanceWindow property: Maintenance window properties of a server.
String	minorVersion() Gets the minorVersion property: The minor version of the server.
String	name() Gets the name property: The name of the resource.
Network	network() Gets the network property: Network properties of a server.
OffsetDateTime	pointInTimeUtc() Gets the pointInTimeUtc property: Restore point creation time (ISO8601 format), specifying the time to restore from.
Server	refresh() Refreshes the resource to sync with Azure.
Server	refresh(com.azure.core.util.Context context) Refreshes the resource to sync with Azure.
com.azure.core.management.Region	region() Gets the region of the resource.
String	regionName() Gets the name of the resource region.
void	restart() Restarts a server.
void	restart(RestartParameter parameters) Restarts a server.
void	restart(RestartParameter parameters, com.azure.core.util.Context context) Restarts a server.
Sku	sku() Gets the sku property: The SKU (pricing tier) of the server.
String	sourceServerResourceId() Gets the sourceServerResourceId property: The source server resource ID to restore from.
void	start() Starts a server.
void	start(com.azure.core.util.Context context) Starts a server.
ServerState	state() Gets the state property: A state of a server that is visible to user.
void	stop() Stops a server.
void	stop(com.azure.core.util.Context context) Stops a server.
Storage	storage() Gets the storage property: Storage properties of a server.
com.azure.core.management.SystemData	systemData() Gets the systemData property: The system metadata relating to this resource.
Map<String,String>	tags() Gets the tags property: Resource tags.
Map<String,String>	tagsPropertiesTags() Gets the tagsPropertiesTags property: Application-specific metadata in the form of key-value pairs.
String	type() Gets the type property: The type of the resource.
Server.Update	update() Begins update for the Server resource.
ServerVersion	version() Gets the version property: PostgreSQL Server version.

Method Detail

id

String id()

Gets the id property: Fully qualified resource Id for the resource.

Returns:

the id value.

name

String name()

Gets the name property: The name of the resource.

Returns:

the name value.

type

String type()

Gets the type property: The type of the resource.

Returns:

the type value.

location

String location()

Gets the location property: The geo-location where the resource lives.

Returns:

the location value.

tags

Map<String,String> tags()

Gets the tags property: Resource tags.

Returns:

the tags value.

sku

Sku sku()

Gets the sku property: The SKU (pricing tier) of the server.

Returns:

the sku value.

systemData

com.azure.core.management.SystemData systemData()

Gets the systemData property: The system metadata relating to this resource.

Returns:

the systemData value.

administratorLogin

String administratorLogin()

Gets the administratorLogin property: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).

Returns:

the administratorLogin value.

administratorLoginPassword

String administratorLoginPassword()

Gets the administratorLoginPassword property: The administrator login password (required for server creation).

Returns:

the administratorLoginPassword value.

version

ServerVersion version()

Gets the version property: PostgreSQL Server version.

Returns:

the version value.

minorVersion

String minorVersion()

Gets the minorVersion property: The minor version of the server.

Returns:

the minorVersion value.

state

ServerState state()

Gets the state property: A state of a server that is visible to user.

Returns:

the state value.

fullyQualifiedDomainName

String fullyQualifiedDomainName()

Gets the fullyQualifiedDomainName property: The fully qualified domain name of a server.

Returns:

the fullyQualifiedDomainName value.

storage

Storage storage()

Gets the storage property: Storage properties of a server.

Returns:

the storage value.

backup

Backup backup()

Gets the backup property: Backup properties of a server.

Returns:

the backup value.

network

Network network()

Gets the network property: Network properties of a server.

Returns:

the network value.

highAvailability

HighAvailability highAvailability()

Gets the highAvailability property: High availability properties of a server.

Returns:

the highAvailability value.

maintenanceWindow

MaintenanceWindow maintenanceWindow()

Gets the maintenanceWindow property: Maintenance window properties of a server.

Returns:

the maintenanceWindow value.

sourceServerResourceId

String sourceServerResourceId()

Gets the sourceServerResourceId property: The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore'.

Returns:

the sourceServerResourceId value.

pointInTimeUtc

OffsetDateTime pointInTimeUtc()

Gets the pointInTimeUtc property: Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore'.

Returns:

the pointInTimeUtc value.

availabilityZone

String availabilityZone()

Gets the availabilityZone property: availability zone information of the server.

Returns:

the availabilityZone value.

createMode

CreateMode createMode()

Gets the createMode property: The mode to create a new PostgreSQL server.

Returns:

the createMode value.

tagsPropertiesTags

Map<String,String> tagsPropertiesTags()

Gets the tagsPropertiesTags property: Application-specific metadata in the form of key-value pairs.

Returns:

the tagsPropertiesTags value.

region

com.azure.core.management.Region region()

Gets the region of the resource.

Returns:

the region of the resource.

regionName

String regionName()

Gets the name of the resource region.

Returns:

the name of the resource region.

innerModel

ServerInner innerModel()

Gets the inner com.azure.resourcemanager.postgresqlflexibleserver.fluent.models.ServerInner object.

Returns:

the inner object.

update

Server.Update update()

Begins update for the Server resource.

Returns:

the stage of resource update.

refresh

Server refresh()

Refreshes the resource to sync with Azure.

Returns:

the refreshed resource.

refresh

Server refresh(com.azure.core.util.Context context)

Refreshes the resource to sync with Azure.

Parameters:

context - The context to associate with this operation.

Returns:

the refreshed resource.

restart

void restart(RestartParameter parameters)

Restarts a server.

Parameters:

parameters - The parameters for restarting a server.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

restart

void restart()

Restarts a server.

Throws:

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

restart

void restart(RestartParameter parameters,
             com.azure.core.util.Context context)

Restarts a server.

Parameters:

parameters - The parameters for restarting a server.

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

start

void start()

Starts a server.

Throws:

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

start

void start(com.azure.core.util.Context context)

Starts a server.

Parameters:

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

stop

void stop()

Stops a server.

Throws:

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

stop

void stop(com.azure.core.util.Context context)

Stops a server.

Parameters:

context - The context to associate with this operation.

Throws:

IllegalArgumentException - thrown if parameters fail the validation.

com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.

RuntimeException - all other wrapped checked exceptions if the request fails to be sent.