257 строки
20 KiB
YAML
257 строки
20 KiB
YAML
### 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:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.management.containerregistry.RunRequest?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"com.microsoft.azure.management.containerregistry.RunRequest?alt=com.microsoft.azure.management.containerregistry.RunRequest&text=RunRequest\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.microsoft.azure.management.containerregistry.RunRequest.isArchiveEnabled()?alt=com.microsoft.azure.management.containerregistry.RunRequest.isArchiveEnabled&text=isArchiveEnabled\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.management.containerregistry.RunRequest.withIsArchiveEnabled(java.lang.Boolean)?alt=com.microsoft.azure.management.containerregistry.RunRequest.withIsArchiveEnabled&text=withIsArchiveEnabled\" data-throw-if-not-resolved=\"False\" />"
|
|
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public class **DockerBuildRequest**</br> extends <xref href=\"com.microsoft.azure.management.containerregistry.RunRequest?alt=com.microsoft.azure.management.containerregistry.RunRequest&text=RunRequest\" data-throw-if-not-resolved=\"False\" />"
|
|
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: "<xref href=\"com.microsoft.azure.management.containerregistry.AgentProperties?alt=com.microsoft.azure.management.containerregistry.AgentProperties&text=AgentProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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<Argument> arguments()"
|
|
desc: "Get the collection of override arguments to be used when executing the run."
|
|
returns:
|
|
description: "the arguments value"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.containerregistry.Argument?alt=com.microsoft.azure.management.containerregistry.Argument&text=Argument\" data-throw-if-not-resolved=\"False\" />>"
|
|
- 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: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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<String> imageNames()"
|
|
desc: "Get the fully qualified image names including the repository and tag."
|
|
returns:
|
|
description: "the imageNames value"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />>"
|
|
- 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: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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: "<xref href=\"com.microsoft.azure.management.containerregistry.PlatformProperties?alt=com.microsoft.azure.management.containerregistry.PlatformProperties&text=PlatformProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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: "<xref href=\"com.microsoft.azure.management.containerregistry.AgentProperties?alt=com.microsoft.azure.management.containerregistry.AgentProperties&text=AgentProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public DockerBuildRequest withAgentConfiguration(AgentProperties agentConfiguration)"
|
|
desc: "Set the machine configuration of the run agent."
|
|
returns:
|
|
description: "the DockerBuildRequest object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.containerregistry.DockerBuildRequest?alt=com.microsoft.azure.management.containerregistry.DockerBuildRequest&text=DockerBuildRequest\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.withArguments(java.util.List<com.microsoft.azure.management.containerregistry.Argument>)"
|
|
fullName: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.withArguments(List<Argument> arguments)"
|
|
name: "withArguments(List<Argument> arguments)"
|
|
nameWithType: "DockerBuildRequest.withArguments(List<Argument> 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: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.containerregistry.Argument?alt=com.microsoft.azure.management.containerregistry.Argument&text=Argument\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public DockerBuildRequest withArguments(List<Argument> arguments)"
|
|
desc: "Set the collection of override arguments to be used when executing the run."
|
|
returns:
|
|
description: "the DockerBuildRequest object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.containerregistry.DockerBuildRequest?alt=com.microsoft.azure.management.containerregistry.DockerBuildRequest&text=DockerBuildRequest\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public DockerBuildRequest withDockerFilePath(String dockerFilePath)"
|
|
desc: "Set the Docker file path relative to the source location."
|
|
returns:
|
|
description: "the DockerBuildRequest object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.containerregistry.DockerBuildRequest?alt=com.microsoft.azure.management.containerregistry.DockerBuildRequest&text=DockerBuildRequest\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.withImageNames(java.util.List<java.lang.String>)"
|
|
fullName: "com.microsoft.azure.management.containerregistry.DockerBuildRequest.withImageNames(List<String> imageNames)"
|
|
name: "withImageNames(List<String> imageNames)"
|
|
nameWithType: "DockerBuildRequest.withImageNames(List<String> imageNames)"
|
|
summary: "Set the fully qualified image names including the repository and tag."
|
|
parameters:
|
|
- description: "the imageNames value to set"
|
|
name: "imageNames"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public DockerBuildRequest withImageNames(List<String> imageNames)"
|
|
desc: "Set the fully qualified image names including the repository and tag."
|
|
returns:
|
|
description: "the DockerBuildRequest object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.containerregistry.DockerBuildRequest?alt=com.microsoft.azure.management.containerregistry.DockerBuildRequest&text=DockerBuildRequest\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
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: "<xref href=\"com.microsoft.azure.management.containerregistry.DockerBuildRequest?alt=com.microsoft.azure.management.containerregistry.DockerBuildRequest&text=DockerBuildRequest\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
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: "<xref href=\"com.microsoft.azure.management.containerregistry.DockerBuildRequest?alt=com.microsoft.azure.management.containerregistry.DockerBuildRequest&text=DockerBuildRequest\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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: "<xref href=\"com.microsoft.azure.management.containerregistry.PlatformProperties?alt=com.microsoft.azure.management.containerregistry.PlatformProperties&text=PlatformProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
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: "<xref href=\"com.microsoft.azure.management.containerregistry.DockerBuildRequest?alt=com.microsoft.azure.management.containerregistry.DockerBuildRequest&text=DockerBuildRequest\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
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: "<xref href=\"com.microsoft.azure.management.containerregistry.DockerBuildRequest?alt=com.microsoft.azure.management.containerregistry.DockerBuildRequest&text=DockerBuildRequest\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public DockerBuildRequest withTimeout(Integer timeout)"
|
|
desc: "Set run timeout in seconds."
|
|
returns:
|
|
description: "the DockerBuildRequest object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.containerregistry.DockerBuildRequest?alt=com.microsoft.azure.management.containerregistry.DockerBuildRequest&text=DockerBuildRequest\" data-throw-if-not-resolved=\"False\" />"
|
|
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
|