Class AbstractAWSApplicationDiscovery
- All Implemented Interfaces:
AWSApplicationDiscovery
- Direct Known Subclasses:
AbstractAWSApplicationDiscoveryAsync
AWSApplicationDiscovery
. Convenient method
forms pass through to the corresponding overload that takes a request object,
which throws an UnsupportedOperationException
.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateTags
(CreateTagsRequest request) Creates one or more tags for configuration items.deleteTags
(DeleteTagsRequest request) Deletes the association between configuration items and one or more tags.describeAgents
(DescribeAgentsRequest request) Lists AWS agents by ID or lists all agents associated with your user account if you did not specify an agent ID.Retrieves a list of attributes for a specific configuration ID.Retrieves the status of a given export process.describeTags
(DescribeTagsRequest request) Retrieves a list of configuration items that are tagged with a specific tag.Exports all discovered configuration data to an Amazon S3 bucket or an application that enables you to view and evaluate the data.Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.Retrieves a list of configurations items according to the criteria you specify in a filter.void
setEndpoint
(String endpoint) Overrides the default endpoint for this client ("https://discovery.us-west-2.amazonaws.com").void
An alternative toAWSApplicationDiscovery.setEndpoint(String)
, sets the regional endpoint for this client's service calls.void
shutdown()
Shuts down this client object, releasing any resources that might be held open.Instructs the specified agents to start collecting data.Instructs the specified agents to stop collecting data.
-
Constructor Details
-
AbstractAWSApplicationDiscovery
protected AbstractAWSApplicationDiscovery()
-
-
Method Details
-
setEndpoint
Description copied from interface:AWSApplicationDiscovery
Overrides the default endpoint for this client ("https://discovery.us-west-2.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.Callers can pass in just the endpoint (ex: "discovery.us-west-2.amazonaws.com") or a full URL, including the protocol (ex: "https://discovery.us-west-2.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's
ClientConfiguration
will be used, which by default is HTTPS.For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Specified by:
setEndpoint
in interfaceAWSApplicationDiscovery
- Parameters:
endpoint
- The endpoint (ex: "discovery.us-west-2.amazonaws.com") or a full URL, including the protocol (ex: "https://discovery.us-west-2.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
-
setRegion
Description copied from interface:AWSApplicationDiscovery
An alternative toAWSApplicationDiscovery.setEndpoint(String)
, sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Specified by:
setRegion
in interfaceAWSApplicationDiscovery
- Parameters:
region
- The region this client will communicate with. SeeRegion.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.- See Also:
-
createTags
Description copied from interface:AWSApplicationDiscovery
Creates one or more tags for configuration items. Tags are metadata that help you categorize IT assets. This API accepts a list of multiple configuration items.
- Specified by:
createTags
in interfaceAWSApplicationDiscovery
- Parameters:
request
-- Returns:
- Result of the CreateTags operation returned by the service.
-
deleteTags
Description copied from interface:AWSApplicationDiscovery
Deletes the association between configuration items and one or more tags. This API accepts a list of multiple configuration items.
- Specified by:
deleteTags
in interfaceAWSApplicationDiscovery
- Parameters:
request
-- Returns:
- Result of the DeleteTags operation returned by the service.
-
describeAgents
Description copied from interface:AWSApplicationDiscovery
Lists AWS agents by ID or lists all agents associated with your user account if you did not specify an agent ID.
- Specified by:
describeAgents
in interfaceAWSApplicationDiscovery
- Parameters:
request
-- Returns:
- Result of the DescribeAgents operation returned by the service.
-
describeConfigurations
Description copied from interface:AWSApplicationDiscovery
Retrieves a list of attributes for a specific configuration ID. For example, the output for a server configuration item includes a list of attributes about the server, including host name, operating system, number of network cards, etc.
- Specified by:
describeConfigurations
in interfaceAWSApplicationDiscovery
- Parameters:
request
-- Returns:
- Result of the DescribeConfigurations operation returned by the service.
-
describeExportConfigurations
public DescribeExportConfigurationsResult describeExportConfigurations(DescribeExportConfigurationsRequest request) Description copied from interface:AWSApplicationDiscovery
Retrieves the status of a given export process. You can retrieve status from a maximum of 100 processes.
- Specified by:
describeExportConfigurations
in interfaceAWSApplicationDiscovery
- Parameters:
request
-- Returns:
- Result of the DescribeExportConfigurations operation returned by the service.
-
describeTags
Description copied from interface:AWSApplicationDiscovery
Retrieves a list of configuration items that are tagged with a specific tag. Or retrieves a list of all tags assigned to a specific configuration item.
- Specified by:
describeTags
in interfaceAWSApplicationDiscovery
- Parameters:
request
-- Returns:
- Result of the DescribeTags operation returned by the service.
-
exportConfigurations
Description copied from interface:AWSApplicationDiscovery
Exports all discovered configuration data to an Amazon S3 bucket or an application that enables you to view and evaluate the data. Data includes tags and tag associations, processes, connections, servers, and system performance. This API returns an export ID which you can query using the GetExportStatus API. The system imposes a limit of two configuration exports in six hours.
- Specified by:
exportConfigurations
in interfaceAWSApplicationDiscovery
- Parameters:
request
-- Returns:
- Result of the ExportConfigurations operation returned by the service.
-
listConfigurations
Description copied from interface:AWSApplicationDiscovery
Retrieves a list of configurations items according to the criteria you specify in a filter. The filter criteria identify relationship requirements.
- Specified by:
listConfigurations
in interfaceAWSApplicationDiscovery
- Parameters:
request
-- Returns:
- Result of the ListConfigurations operation returned by the service.
-
startDataCollectionByAgentIds
public StartDataCollectionByAgentIdsResult startDataCollectionByAgentIds(StartDataCollectionByAgentIdsRequest request) Description copied from interface:AWSApplicationDiscovery
Instructs the specified agents to start collecting data. Agents can reside on host servers or virtual machines in your data center.
- Specified by:
startDataCollectionByAgentIds
in interfaceAWSApplicationDiscovery
- Parameters:
request
-- Returns:
- Result of the StartDataCollectionByAgentIds operation returned by the service.
-
stopDataCollectionByAgentIds
public StopDataCollectionByAgentIdsResult stopDataCollectionByAgentIds(StopDataCollectionByAgentIdsRequest request) Description copied from interface:AWSApplicationDiscovery
Instructs the specified agents to stop collecting data.
- Specified by:
stopDataCollectionByAgentIds
in interfaceAWSApplicationDiscovery
- Parameters:
request
-- Returns:
- Result of the StopDataCollectionByAgentIds operation returned by the service.
-
shutdown
public void shutdown()Description copied from interface:AWSApplicationDiscovery
Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.- Specified by:
shutdown
in interfaceAWSApplicationDiscovery
-
getCachedResponseMetadata
Description copied from interface:AWSApplicationDiscovery
Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
- Specified by:
getCachedResponseMetadata
in interfaceAWSApplicationDiscovery
- Parameters:
request
- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-