@InterfaceAudience.Public @InterfaceStability.Stable public abstract class LocalResource extends Object
LocalResource
represents a local resource required to
run a container.
The NodeManager
is responsible for localizing the resource
prior to launching the container.
Applications can specify LocalResourceType
and
LocalResourceVisibility
.
Constructor and Description |
---|
LocalResource() |
Modifier and Type | Method and Description |
---|---|
abstract String |
getPattern()
Get the pattern that should be used to extract entries from the
archive (only used when type is
PATTERN ). |
abstract URL |
getResource()
Get the location of the resource to be localized.
|
abstract boolean |
getShouldBeUploadedToSharedCache()
NM uses it to decide whether if it is necessary to upload the resource to
the shared cache
|
abstract long |
getSize()
Get the size of the resource to be localized.
|
abstract long |
getTimestamp()
Get the original timestamp of the resource to be localized, used
for verification.
|
abstract LocalResourceType |
getType()
Get the
LocalResourceType of the resource to be localized. |
abstract LocalResourceVisibility |
getVisibility()
Get the
LocalResourceVisibility of the resource to be
localized. |
static LocalResource |
newInstance(URL url,
LocalResourceType type,
LocalResourceVisibility visibility,
long size,
long timestamp) |
static LocalResource |
newInstance(URL url,
LocalResourceType type,
LocalResourceVisibility visibility,
long size,
long timestamp,
boolean shouldBeUploadedToSharedCache) |
static LocalResource |
newInstance(URL url,
LocalResourceType type,
LocalResourceVisibility visibility,
long size,
long timestamp,
String pattern) |
static LocalResource |
newInstance(URL url,
LocalResourceType type,
LocalResourceVisibility visibility,
long size,
long timestamp,
String pattern,
boolean shouldBeUploadedToSharedCache) |
abstract void |
setPattern(String pattern)
Set the pattern that should be used to extract entries from the
archive (only used when type is
PATTERN ). |
abstract void |
setResource(URL resource)
Set location of the resource to be localized.
|
abstract void |
setShouldBeUploadedToSharedCache(boolean shouldBeUploadedToSharedCache)
Inform NM whether upload to SCM is needed.
|
abstract void |
setSize(long size)
Set the size of the resource to be localized.
|
abstract void |
setTimestamp(long timestamp)
Set the timestamp of the resource to be localized, used
for verification.
|
abstract void |
setType(LocalResourceType type)
Set the
LocalResourceType of the resource to be localized. |
abstract void |
setVisibility(LocalResourceVisibility visibility)
Set the
LocalResourceVisibility of the resource to be
localized. |
@InterfaceAudience.Public @InterfaceStability.Stable public static LocalResource newInstance(URL url, LocalResourceType type, LocalResourceVisibility visibility, long size, long timestamp, String pattern)
@InterfaceAudience.Public @InterfaceStability.Unstable public static LocalResource newInstance(URL url, LocalResourceType type, LocalResourceVisibility visibility, long size, long timestamp, String pattern, boolean shouldBeUploadedToSharedCache)
@InterfaceAudience.Public @InterfaceStability.Stable public static LocalResource newInstance(URL url, LocalResourceType type, LocalResourceVisibility visibility, long size, long timestamp)
@InterfaceAudience.Public @InterfaceStability.Unstable public static LocalResource newInstance(URL url, LocalResourceType type, LocalResourceVisibility visibility, long size, long timestamp, boolean shouldBeUploadedToSharedCache)
@InterfaceAudience.Public @InterfaceStability.Stable public abstract URL getResource()
@InterfaceAudience.Public @InterfaceStability.Stable public abstract void setResource(URL resource)
resource
- location of the resource to be localized@InterfaceAudience.Public @InterfaceStability.Stable public abstract long getSize()
@InterfaceAudience.Public @InterfaceStability.Stable public abstract void setSize(long size)
size
- size of the resource to be localized@InterfaceAudience.Public @InterfaceStability.Stable public abstract long getTimestamp()
@InterfaceAudience.Public @InterfaceStability.Stable public abstract void setTimestamp(long timestamp)
timestamp
- timestamp of the resource to be localized@InterfaceAudience.Public @InterfaceStability.Stable public abstract LocalResourceType getType()
LocalResourceType
of the resource to be localized.LocalResourceType
of the resource to be localized@InterfaceAudience.Public @InterfaceStability.Stable public abstract void setType(LocalResourceType type)
LocalResourceType
of the resource to be localized.type
- LocalResourceType
of the resource to be localized@InterfaceAudience.Public @InterfaceStability.Stable public abstract LocalResourceVisibility getVisibility()
LocalResourceVisibility
of the resource to be
localized.LocalResourceVisibility
of the resource to be
localized@InterfaceAudience.Public @InterfaceStability.Stable public abstract void setVisibility(LocalResourceVisibility visibility)
LocalResourceVisibility
of the resource to be
localized.visibility
- LocalResourceVisibility
of the resource to be
localized@InterfaceAudience.Public @InterfaceStability.Stable public abstract String getPattern()
PATTERN
).@InterfaceAudience.Public @InterfaceStability.Stable public abstract void setPattern(String pattern)
PATTERN
).pattern
- pattern that should be used to extract entries
from the archive.@InterfaceAudience.Public @InterfaceStability.Unstable public abstract boolean getShouldBeUploadedToSharedCache()
@InterfaceAudience.Public @InterfaceStability.Unstable public abstract void setShouldBeUploadedToSharedCache(boolean shouldBeUploadedToSharedCache)
shouldBeUploadedToSharedCache
- shouldBeUploadedToSharedCache
of this requestCopyright © 2023 Apache Software Foundation. All rights reserved.