ImageReference (Jib 1.5.1 API)

java.lang.Object
- com.google.cloud.tools.jib.api.ImageReference

```
public class ImageReference
extends Object
```
Represents an image reference.

See Also:

https://github.com/docker/distribution/blob/master/reference/reference.go, https://docs.docker.com/engine/reference/commandline/tag/#extended-description

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getRegistry()` Gets the registry portion of the `ImageReference`.
`String`	`getRepository()` Gets the repository portion of the `ImageReference`.
`String`	`getTag()` Gets the tag portion of the `ImageReference`.
`static boolean`	`isDefaultTag(String tag)` Returns `true` if `tag` is the default tag ((@code latest} or empty); `false` if not.
`boolean`	`isScratch()` Returns `true` if the `ImageReference` is a scratch image; `false` if not.
`boolean`	`isTagDigest()` Returns `true` if the `ImageReference` uses a SHA-256 digest as its tag; `false` if not.
`static boolean`	`isValidRegistry(String registry)` Returns `true` if `registry` is a valid registry string.
`static boolean`	`isValidRepository(String repository)` Returns `true` if `repository` is a valid repository string.
`static boolean`	`isValidTag(String tag)` Returns `true` if `tag` is a valid tag string.
`static ImageReference`	`of(String registry, String repository, String tag)` Constructs an `ImageReference` from the image reference components, consisting of an optional registry, a repository, and an optional tag.
`static ImageReference`	`parse(String reference)` Parses a string `reference` into an `ImageReference`.
`static ImageReference`	`scratch()` Constructs an `ImageReference` with an empty registry and tag component, and repository set to "scratch".
`String`	`toString()` Stringifies the `ImageReference`.
`String`	`toStringWithTag()` Stringifies the `ImageReference`, without hiding the tag.
`boolean`	`usesDefaultTag()` Returns `true` if the `ImageReference` uses the default tag ((@code latest} or empty); `false` if not
`ImageReference`	`withTag(String newTag)` Gets an `ImageReference` with the same registry and repository, but a different tag.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - parse
```
public static ImageReference parse(String reference)
                            throws InvalidImageReferenceException
```
    Parses a string reference into an ImageReference.
    Image references should generally be in the form: <registry>/<repository>:<tag> For example, an image reference could be gcr.io/distroless/java:debug.
    See https://docs.docker.com/engine/reference/commandline/tag/#extended-description for a description of valid image reference format. Note, however, that the image reference is referred confusingly as tag on that page.
    
    Parameters:
    
    reference - the string to parse
    
    Returns:
    
    an ImageReference parsed from the string
    
    Throws:
    
    InvalidImageReferenceException - if reference is formatted incorrectly
  - of
```
public static ImageReference of(@Nullable
                                String registry,
                                String repository,
                                @Nullable
                                String tag)
```
    Constructs an ImageReference from the image reference components, consisting of an optional registry, a repository, and an optional tag.
    
    Parameters:
    
    registry - the image registry, or null to use the default registry (Docker Hub)
    
    repository - the image repository
    
    tag - the image tag, or null to use the default tag (latest)
    
    Returns:
    
    an ImageReference built from the given registry, repository, and tag
  - scratch
```
public static ImageReference scratch()
```
    Constructs an ImageReference with an empty registry and tag component, and repository set to "scratch".
    
    Returns:
    
    an ImageReference with an empty registry and tag component, and repository set to "scratch"
  - isValidRegistry
```
public static boolean isValidRegistry(String registry)
```
    Returns true if registry is a valid registry string. For example, a valid registry could be gcr.io or localhost:5000.
    
    Parameters:
    
    registry - the registry to check
    
    Returns:
    
    true if is a valid registry; false otherwise
  - isValidRepository
```
public static boolean isValidRepository(String repository)
```
    Returns true if repository is a valid repository string. For example, a valid repository could be distroless or my/container-image/repository.
    
    Parameters:
    
    repository - the repository to check
    
    Returns:
    
    true if is a valid repository; false otherwise
  - isValidTag
```
public static boolean isValidTag(String tag)
```
    Returns true if tag is a valid tag string. For example, a valid tag could be v120.5-release.
    
    Parameters:
    
    tag - the tag to check
    
    Returns:
    
    true if is a valid tag; false otherwise
  - isDefaultTag
```
public static boolean isDefaultTag(String tag)
```
    Returns true if tag is the default tag ((@code latest} or empty); false if not.
    
    Parameters:
    
    tag - the tag to check
    
    Returns:
    
    true if tag is the default tag ((@code latest} or empty); false if not
  - getRegistry
```
public String getRegistry()
```
    Gets the registry portion of the ImageReference.
    
    Returns:
    
    the registry host
  - getRepository
```
public String getRepository()
```
    Gets the repository portion of the ImageReference.
    
    Returns:
    
    the repository
  - getTag
```
public String getTag()
```
    Gets the tag portion of the ImageReference.
    
    Returns:
    
    the tag
  - usesDefaultTag
```
public boolean usesDefaultTag()
```
    Returns true if the ImageReference uses the default tag ((@code latest} or empty); false if not
    
    Returns:
    
    true if uses the default tag; false if not
  - isTagDigest
```
public boolean isTagDigest()
```
    Returns true if the ImageReference uses a SHA-256 digest as its tag; false if not.
    
    Returns:
    
    true if tag is a SHA-256 digest; false if not
  - isScratch
```
public boolean isScratch()
```
    Returns true if the ImageReference is a scratch image; false if not.
    
    Returns:
    
    true if the ImageReference is a scratch image; false if not
  - withTag
```
public ImageReference withTag(String newTag)
```
    Gets an ImageReference with the same registry and repository, but a different tag.
    
    Parameters:
    
    newTag - the new tag
    
    Returns:
    
    an ImageReference with the same registry/repository and the new tag
  - toString
```
public String toString()
```
    Stringifies the ImageReference. When the tag is a digest, it is prepended with the at @ symbol instead of a colon :.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the image reference in Docker-readable format (inverse of parse(java.lang.String))
  - toStringWithTag
```
public String toStringWithTag()
```
    Stringifies the ImageReference, without hiding the tag.
    
    Returns:
    
    the image reference in Docker-readable format, without hiding the tag

Class ImageReference

Method Summary

Methods inherited from class java.lang.Object

Method Detail

parse

of

scratch

isValidRegistry

isValidRepository

isValidTag

isDefaultTag

getRegistry

getRepository

getTag

usesDefaultTag

isTagDigest

isScratch

withTag

toString

toStringWithTag