Class CreateResourceSnapshotJobRequest

    • Method Detail

      • catalog

        public final String catalog()

        Specifies the catalog in which to create the snapshot job. Valid values are AWS and Sandbox.

        Returns:
        Specifies the catalog in which to create the snapshot job. Valid values are AWS and Sandbox.
      • clientToken

        public final String clientToken()

        A client-generated UUID used for idempotency check. The token helps prevent duplicate job creations.

        Returns:
        A client-generated UUID used for idempotency check. The token helps prevent duplicate job creations.
      • engagementIdentifier

        public final String engagementIdentifier()

        Specifies the identifier of the engagement associated with the resource to be snapshotted.

        Returns:
        Specifies the identifier of the engagement associated with the resource to be snapshotted.
      • resourceIdentifier

        public final String resourceIdentifier()

        Specifies the identifier of the specific resource to be snapshotted. The format depends on the ResourceType.

        Returns:
        Specifies the identifier of the specific resource to be snapshotted. The format depends on the ResourceType.
      • resourceSnapshotTemplateIdentifier

        public final String resourceSnapshotTemplateIdentifier()

        Specifies the name of the template that defines the schema for the snapshot.

        Returns:
        Specifies the name of the template that defines the schema for the snapshot.
      • resourceType

        public final ResourceType resourceType()

        The type of resource for which the snapshot job is being created. Must be one of the supported resource types i.e. Opportunity

        If the service returns an enum value that is not available in the current SDK version, resourceType will return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

        Returns:
        The type of resource for which the snapshot job is being created. Must be one of the supported resource types i.e. Opportunity
        See Also:
        ResourceType
      • resourceTypeAsString

        public final String resourceTypeAsString()

        The type of resource for which the snapshot job is being created. Must be one of the supported resource types i.e. Opportunity

        If the service returns an enum value that is not available in the current SDK version, resourceType will return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

        Returns:
        The type of resource for which the snapshot job is being created. Must be one of the supported resource types i.e. Opportunity
        See Also:
        ResourceType
      • 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 the isEmpty() 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

        public final List<Tag> tags()

        A list of objects specifying each tag name and value.

        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:
        A list of objects specifying each tag name and value.
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object