### YamlMime:JavaType
uid: "com.microsoft.azure.management.containerregistry.DockerBuildRequest"
fullName: "com.microsoft.azure.management.containerregistry.DockerBuildRequest"
name: "DockerBuildRequest"
nameWithType: "DockerBuildRequest"
summary: "The parameters for a docker quick build."
inheritances:
- ""
- ""
inheritedClassMethods:
- classRef: ""
methodsRef:
- ""
- ""
- classRef: ""
methodsRef:
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
syntax: "public class **DockerBuildRequest** extends "
constructors:
- uid: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.DockerBuildRequest()"
fullName: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.DockerBuildRequest()"
name: "DockerBuildRequest()"
nameWithType: "DockerBuildRequest.DockerBuildRequest()"
syntax: "public DockerBuildRequest()"
methods:
- uid: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.agentConfiguration()"
fullName: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.agentConfiguration()"
name: "agentConfiguration()"
nameWithType: "DockerBuildRequest.agentConfiguration()"
summary: "Get the machine configuration of the run agent."
syntax: "public AgentProperties agentConfiguration()"
desc: "Get the machine configuration of the run agent."
returns:
description: "the agentConfiguration value"
type: ""
- uid: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.arguments()"
fullName: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.arguments()"
name: "arguments()"
nameWithType: "DockerBuildRequest.arguments()"
summary: "Get the collection of override arguments to be used when executing the run."
syntax: "public List arguments()"
desc: "Get the collection of override arguments to be used when executing the run."
returns:
description: "the arguments value"
type: "<>"
- uid: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.dockerFilePath()"
fullName: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.dockerFilePath()"
name: "dockerFilePath()"
nameWithType: "DockerBuildRequest.dockerFilePath()"
summary: "Get the Docker file path relative to the source location."
syntax: "public String dockerFilePath()"
desc: "Get the Docker file path relative to the source location."
returns:
description: "the dockerFilePath value"
type: ""
- uid: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.imageNames()"
fullName: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.imageNames()"
name: "imageNames()"
nameWithType: "DockerBuildRequest.imageNames()"
summary: "Get the fully qualified image names including the repository and tag."
syntax: "public List imageNames()"
desc: "Get the fully qualified image names including the repository and tag."
returns:
description: "the imageNames value"
type: "<>"
- uid: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.isPushEnabled()"
fullName: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.isPushEnabled()"
name: "isPushEnabled()"
nameWithType: "DockerBuildRequest.isPushEnabled()"
summary: "Get the value of this property indicates whether the image built should be pushed to the registry or not."
syntax: "public Boolean isPushEnabled()"
desc: "Get the value of this property indicates whether the image built should be pushed to the registry or not."
returns:
description: "the isPushEnabled value"
type: ""
- uid: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.noCache()"
fullName: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.noCache()"
name: "noCache()"
nameWithType: "DockerBuildRequest.noCache()"
summary: "Get the value of this property indicates whether the image cache is enabled or not."
syntax: "public Boolean noCache()"
desc: "Get the value of this property indicates whether the image cache is enabled or not."
returns:
description: "the noCache value"
type: ""
- uid: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.platform()"
fullName: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.platform()"
name: "platform()"
nameWithType: "DockerBuildRequest.platform()"
summary: "Get the platform properties against which the run has to happen."
syntax: "public PlatformProperties platform()"
desc: "Get the platform properties against which the run has to happen."
returns:
description: "the platform value"
type: ""
- uid: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.sourceLocation()"
fullName: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.sourceLocation()"
name: "sourceLocation()"
nameWithType: "DockerBuildRequest.sourceLocation()"
summary: "Get the URL(absolute or relative) of the source context."
syntax: "public String sourceLocation()"
desc: "Get the URL(absolute or relative) of the source context. It can be an URL to a tar or git repoistory. If it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API."
returns:
description: "the sourceLocation value"
type: ""
- uid: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.timeout()"
fullName: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.timeout()"
name: "timeout()"
nameWithType: "DockerBuildRequest.timeout()"
summary: "Get run timeout in seconds."
syntax: "public Integer timeout()"
desc: "Get run timeout in seconds."
returns:
description: "the timeout value"
type: ""
- uid: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.withAgentConfiguration(com.microsoft.azure.management.containerregistry.AgentProperties)"
fullName: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.withAgentConfiguration(AgentProperties agentConfiguration)"
name: "withAgentConfiguration(AgentProperties agentConfiguration)"
nameWithType: "DockerBuildRequest.withAgentConfiguration(AgentProperties agentConfiguration)"
summary: "Set the machine configuration of the run agent."
parameters:
- description: "the agentConfiguration value to set"
name: "agentConfiguration"
type: ""
syntax: "public DockerBuildRequest withAgentConfiguration(AgentProperties agentConfiguration)"
desc: "Set the machine configuration of the run agent."
returns:
description: "the DockerBuildRequest object itself."
type: ""
- uid: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.withArguments(java.util.List)"
fullName: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.withArguments(List arguments)"
name: "withArguments(List arguments)"
nameWithType: "DockerBuildRequest.withArguments(List arguments)"
summary: "Set the collection of override arguments to be used when executing the run."
parameters:
- description: "the arguments value to set"
name: "arguments"
type: "<>"
syntax: "public DockerBuildRequest withArguments(List arguments)"
desc: "Set the collection of override arguments to be used when executing the run."
returns:
description: "the DockerBuildRequest object itself."
type: ""
- uid: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.withDockerFilePath(java.lang.String)"
fullName: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.withDockerFilePath(String dockerFilePath)"
name: "withDockerFilePath(String dockerFilePath)"
nameWithType: "DockerBuildRequest.withDockerFilePath(String dockerFilePath)"
summary: "Set the Docker file path relative to the source location."
parameters:
- description: "the dockerFilePath value to set"
name: "dockerFilePath"
type: ""
syntax: "public DockerBuildRequest withDockerFilePath(String dockerFilePath)"
desc: "Set the Docker file path relative to the source location."
returns:
description: "the DockerBuildRequest object itself."
type: ""
- uid: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.withImageNames(java.util.List)"
fullName: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.withImageNames(List imageNames)"
name: "withImageNames(List imageNames)"
nameWithType: "DockerBuildRequest.withImageNames(List imageNames)"
summary: "Set the fully qualified image names including the repository and tag."
parameters:
- description: "the imageNames value to set"
name: "imageNames"
type: "<>"
syntax: "public DockerBuildRequest withImageNames(List imageNames)"
desc: "Set the fully qualified image names including the repository and tag."
returns:
description: "the DockerBuildRequest object itself."
type: ""
- uid: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.withIsPushEnabled(java.lang.Boolean)"
fullName: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.withIsPushEnabled(Boolean isPushEnabled)"
name: "withIsPushEnabled(Boolean isPushEnabled)"
nameWithType: "DockerBuildRequest.withIsPushEnabled(Boolean isPushEnabled)"
summary: "Set the value of this property indicates whether the image built should be pushed to the registry or not."
parameters:
- description: "the isPushEnabled value to set"
name: "isPushEnabled"
type: ""
syntax: "public DockerBuildRequest withIsPushEnabled(Boolean isPushEnabled)"
desc: "Set the value of this property indicates whether the image built should be pushed to the registry or not."
returns:
description: "the DockerBuildRequest object itself."
type: ""
- uid: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.withNoCache(java.lang.Boolean)"
fullName: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.withNoCache(Boolean noCache)"
name: "withNoCache(Boolean noCache)"
nameWithType: "DockerBuildRequest.withNoCache(Boolean noCache)"
summary: "Set the value of this property indicates whether the image cache is enabled or not."
parameters:
- description: "the noCache value to set"
name: "noCache"
type: ""
syntax: "public DockerBuildRequest withNoCache(Boolean noCache)"
desc: "Set the value of this property indicates whether the image cache is enabled or not."
returns:
description: "the DockerBuildRequest object itself."
type: ""
- uid: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.withPlatform(com.microsoft.azure.management.containerregistry.PlatformProperties)"
fullName: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.withPlatform(PlatformProperties platform)"
name: "withPlatform(PlatformProperties platform)"
nameWithType: "DockerBuildRequest.withPlatform(PlatformProperties platform)"
summary: "Set the platform properties against which the run has to happen."
parameters:
- description: "the platform value to set"
name: "platform"
type: ""
syntax: "public DockerBuildRequest withPlatform(PlatformProperties platform)"
desc: "Set the platform properties against which the run has to happen."
returns:
description: "the DockerBuildRequest object itself."
type: ""
- uid: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.withSourceLocation(java.lang.String)"
fullName: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.withSourceLocation(String sourceLocation)"
name: "withSourceLocation(String sourceLocation)"
nameWithType: "DockerBuildRequest.withSourceLocation(String sourceLocation)"
summary: "Set the URL(absolute or relative) of the source context."
parameters:
- description: "the sourceLocation value to set"
name: "sourceLocation"
type: ""
syntax: "public DockerBuildRequest withSourceLocation(String sourceLocation)"
desc: "Set the URL(absolute or relative) of the source context. It can be an URL to a tar or git repoistory. If it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API."
returns:
description: "the DockerBuildRequest object itself."
type: ""
- uid: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.withTimeout(java.lang.Integer)"
fullName: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.withTimeout(Integer timeout)"
name: "withTimeout(Integer timeout)"
nameWithType: "DockerBuildRequest.withTimeout(Integer timeout)"
summary: "Set run timeout in seconds."
parameters:
- description: "the timeout value to set"
name: "timeout"
type: ""
syntax: "public DockerBuildRequest withTimeout(Integer timeout)"
desc: "Set run timeout in seconds."
returns:
description: "the DockerBuildRequest object itself."
type: ""
type: "class"
desc: "The parameters for a docker quick build."
metadata: {}
package: "com.microsoft.azure.management.containerregistry"
artifact: com.microsoft.azure:azure-mgmt-containerregistry:1.41.4