Package io.github.cdklabs.projen.github

Interface UploadGitPatchOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

UploadGitPatchOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.093Z")
@Stability(Experimental)
public interface UploadGitPatchOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options for uploadGitPatch.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	UploadGitPatchOptions.Builder	A builder for UploadGitPatchOptions
static class	UploadGitPatchOptions.Jsii$Proxy	An implementation for UploadGitPatchOptions

Method Summary

Modifier and Type	Method	Description
static UploadGitPatchOptions.Builder	builder()
default String	getMutationError()	(experimental) Fail if a mutation was found and print this error message.
String	getOutputName()	(experimental) The name of the output to emit.
default String	getPatchFile()	(experimental) The name of the artifact the patch is stored as.
String	getStepId()	(experimental) The step ID which produces the output which indicates if a patch was created.
default String	getStepName()	(experimental) The name of the step.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getOutputName

@Stability(Experimental)
@NotNull
String getOutputName()

(experimental) The name of the output to emit.

It will be set to true if there was a diff.

getStepId

@Stability(Experimental)
@NotNull
String getStepId()

(experimental) The step ID which produces the output which indicates if a patch was created.

getMutationError

@Stability(Experimental)
@Nullable
default String getMutationError()

(experimental) Fail if a mutation was found and print this error message.

Default: - do not fail upon mutation

getPatchFile

@Stability(Experimental)
@Nullable
default String getPatchFile()

(experimental) The name of the artifact the patch is stored as.

Default: ".repo.patch"

getStepName

@Stability(Experimental)
@Nullable
default String getStepName()

(experimental) The name of the step.

Default: "Find mutations"

builder

@Stability(Experimental)
static UploadGitPatchOptions.Builder builder()

Returns:

a UploadGitPatchOptions.Builder of UploadGitPatchOptions