Class RemoteSourceActionJob
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<RemoteSourceActionJob.Builder,RemoteSourceActionJob>
A job that runs a source action on source servers through a connector.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal Stringarn()The Amazon Resource Name (ARN) of the job.builder()final StringThe ARN of the connector that runs the job.final InstantendedAt()The timestamp when the job completed or failed.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()final booleanFor responses, this returns true if the service returned a value for the RemoteSourceActionArns property.final booleanFor responses, this returns true if the service returned a value for the SourceServerArns property.final booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.The ARNs of the source actions that the job runs.final StringThe unique identifier of the job.static Class<? extends RemoteSourceActionJob.Builder> The ARNs of the source servers that the job runs on.final InstantThe timestamp when the job started running.status()The current status of the job.final StringThe current status of the job.final StringThe reason the job failed.tags()Tags assigned to the job.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
remoteSourceActionJobID
The unique identifier of the job.
- Returns:
- The unique identifier of the job.
-
arn
The Amazon Resource Name (ARN) of the job.
- Returns:
- The Amazon Resource Name (ARN) of the job.
-
status
The current status of the job.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnRemoteSourceActionJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The current status of the job.
- See Also:
-
statusAsString
The current status of the job.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnRemoteSourceActionJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The current status of the job.
- See Also:
-
hasSourceServerArns
public final boolean hasSourceServerArns()For responses, this returns true if the service returned a value for the SourceServerArns property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
sourceServerArns
The ARNs of the source servers that the job runs on.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasSourceServerArns()method.- Returns:
- The ARNs of the source servers that the job runs on.
-
hasRemoteSourceActionArns
public final boolean hasRemoteSourceActionArns()For responses, this returns true if the service returned a value for the RemoteSourceActionArns property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
remoteSourceActionArns
The ARNs of the source actions that the job runs.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasRemoteSourceActionArns()method.- Returns:
- The ARNs of the source actions that the job runs.
-
connectorArn
The ARN of the connector that runs the job.
- Returns:
- The ARN of the connector that runs the job.
-
startedAt
The timestamp when the job started running.
- Returns:
- The timestamp when the job started running.
-
endedAt
The timestamp when the job completed or failed.
- Returns:
- The timestamp when the job completed or failed.
-
statusReason
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
Tags assigned to the job.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()method.- Returns:
- Tags assigned to the job.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<RemoteSourceActionJob.Builder,RemoteSourceActionJob> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-