Skip to content

Latest commit

 

History

History
1359 lines (849 loc) · 61.4 KB

repositoryPullRequest.java.md

File metadata and controls

1359 lines (849 loc) · 61.4 KB
Raw

repositoryPullRequest Submodule

Constructs

RepositoryPullRequest

Represents a {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/repository_pull_request github_repository_pull_request}.

Initializers 

import com.hashicorp.cdktf.providers.github.repository_pull_request.RepositoryPullRequest;

RepositoryPullRequest.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .baseRef(java.lang.String)
    .baseRepository(java.lang.String)
    .headRef(java.lang.String)
    .title(java.lang.String)
//  .body(java.lang.String)
//  .id(java.lang.String)
//  .maintainerCanModify(java.lang.Boolean)
//  .maintainerCanModify(IResolvable)
//  .owner(java.lang.String)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
baseRef java.lang.String Name of the branch serving as the base of the Pull Request.
baseRepository java.lang.String Name of the base repository to retrieve the Pull Requests from.
headRef java.lang.String Name of the branch serving as the head of the Pull Request.
title java.lang.String The title of the Pull Request.
body java.lang.String Body of the Pull Request.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/repository_pull_request#id RepositoryPullRequest#id}.
maintainerCanModify java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Controls whether the base repository maintainers can modify the Pull Request. Default: 'false'.
owner java.lang.String Owner of the repository. If not provided, the provider's default owner is used.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
baseRefRequired
  • Type: java.lang.String

Name of the branch serving as the base of the Pull Request.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/repository_pull_request#base_ref RepositoryPullRequest#base_ref}

baseRepositoryRequired
  • Type: java.lang.String

Name of the base repository to retrieve the Pull Requests from.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/repository_pull_request#base_repository RepositoryPullRequest#base_repository}

headRefRequired
  • Type: java.lang.String

Name of the branch serving as the head of the Pull Request.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/repository_pull_request#head_ref RepositoryPullRequest#head_ref}

titleRequired
  • Type: java.lang.String

The title of the Pull Request.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/repository_pull_request#title RepositoryPullRequest#title}

bodyOptional
  • Type: java.lang.String

Body of the Pull Request.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/repository_pull_request#body RepositoryPullRequest#body}

idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/repository_pull_request#id RepositoryPullRequest#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

maintainerCanModifyOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Controls whether the base repository maintainers can modify the Pull Request. Default: 'false'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/repository_pull_request#maintainer_can_modify RepositoryPullRequest#maintainer_can_modify}

ownerOptional
  • Type: java.lang.String

Owner of the repository. If not provided, the provider's default owner is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/repository_pull_request#owner RepositoryPullRequest#owner}

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
resetBody No description.
resetId No description.
resetMaintainerCanModify No description.
resetOwner No description.
toString 
public java.lang.String toString()

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget 
public void addMoveTarget(java.lang.String moveTarget)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.

getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
hasResourceMove 
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom 
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
moveFromId 
public void moveFromId(java.lang.String id)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: java.lang.String

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

moveTo 
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: java.lang.String OR java.lang.Number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

moveToId 
public void moveToId(java.lang.String id)

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: java.lang.String

Full id of resource to move to, e.g. "aws_s3_bucket.example".

resetBody 
public void resetBody()
resetId 
public void resetId()
resetMaintainerCanModify 
public void resetMaintainerCanModify()
resetOwner 
public void resetOwner()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a RepositoryPullRequest resource upon running "cdktf plan ".
isConstruct 
import com.hashicorp.cdktf.providers.github.repository_pull_request.RepositoryPullRequest;

RepositoryPullRequest.isConstruct(java.lang.Object x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.github.repository_pull_request.RepositoryPullRequest;

RepositoryPullRequest.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.github.repository_pull_request.RepositoryPullRequest;

RepositoryPullRequest.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.github.repository_pull_request.RepositoryPullRequest;

RepositoryPullRequest.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),RepositoryPullRequest.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

Generates CDKTF code for importing a RepositoryPullRequest resource upon running "cdktf plan ".

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

The construct id used in the generated config for the RepositoryPullRequest to import.

importFromIdRequired
  • Type: java.lang.String

The id of the existing RepositoryPullRequest that should be imported.

Refer to the {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/repository_pull_request#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

? Optional instance of the provider where the RepositoryPullRequest to import is found.

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
baseSha java.lang.String No description.
draft com.hashicorp.cdktf.IResolvable No description.
headSha java.lang.String No description.
labels java.util.List<java.lang.String> No description.
number java.lang.Number No description.
openedAt java.lang.Number No description.
openedBy java.lang.String No description.
state java.lang.String No description.
updatedAt java.lang.Number No description.
baseRefInput java.lang.String No description.
baseRepositoryInput java.lang.String No description.
bodyInput java.lang.String No description.
headRefInput java.lang.String No description.
idInput java.lang.String No description.
maintainerCanModifyInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
ownerInput java.lang.String No description.
titleInput java.lang.String No description.
baseRef java.lang.String No description.
baseRepository java.lang.String No description.
body java.lang.String No description.
headRef java.lang.String No description.
id java.lang.String No description.
maintainerCanModify java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
owner java.lang.String No description.
title java.lang.String No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
baseShaRequired 
public java.lang.String getBaseSha();
  • Type: java.lang.String
draftRequired 
public IResolvable getDraft();
  • Type: com.hashicorp.cdktf.IResolvable
headShaRequired 
public java.lang.String getHeadSha();
  • Type: java.lang.String
labelsRequired 
public java.util.List<java.lang.String> getLabels();
  • Type: java.util.List<java.lang.String>
numberRequired 
public java.lang.Number getNumber();
  • Type: java.lang.Number
openedAtRequired 
public java.lang.Number getOpenedAt();
  • Type: java.lang.Number
openedByRequired 
public java.lang.String getOpenedBy();
  • Type: java.lang.String
stateRequired 
public java.lang.String getState();
  • Type: java.lang.String
updatedAtRequired 
public java.lang.Number getUpdatedAt();
  • Type: java.lang.Number
baseRefInputOptional 
public java.lang.String getBaseRefInput();
  • Type: java.lang.String
baseRepositoryInputOptional 
public java.lang.String getBaseRepositoryInput();
  • Type: java.lang.String
bodyInputOptional 
public java.lang.String getBodyInput();
  • Type: java.lang.String
headRefInputOptional 
public java.lang.String getHeadRefInput();
  • Type: java.lang.String
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
maintainerCanModifyInputOptional 
public java.lang.Object getMaintainerCanModifyInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
ownerInputOptional 
public java.lang.String getOwnerInput();
  • Type: java.lang.String
titleInputOptional 
public java.lang.String getTitleInput();
  • Type: java.lang.String
baseRefRequired 
public java.lang.String getBaseRef();
  • Type: java.lang.String
baseRepositoryRequired 
public java.lang.String getBaseRepository();
  • Type: java.lang.String
bodyRequired 
public java.lang.String getBody();
  • Type: java.lang.String
headRefRequired 
public java.lang.String getHeadRef();
  • Type: java.lang.String
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
maintainerCanModifyRequired 
public java.lang.Object getMaintainerCanModify();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
ownerRequired 
public java.lang.String getOwner();
  • Type: java.lang.String
titleRequired 
public java.lang.String getTitle();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

RepositoryPullRequestConfig

Initializer 

import com.hashicorp.cdktf.providers.github.repository_pull_request.RepositoryPullRequestConfig;

RepositoryPullRequestConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .baseRef(java.lang.String)
    .baseRepository(java.lang.String)
    .headRef(java.lang.String)
    .title(java.lang.String)
//  .body(java.lang.String)
//  .id(java.lang.String)
//  .maintainerCanModify(java.lang.Boolean)
//  .maintainerCanModify(IResolvable)
//  .owner(java.lang.String)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
baseRef java.lang.String Name of the branch serving as the base of the Pull Request.
baseRepository java.lang.String Name of the base repository to retrieve the Pull Requests from.
headRef java.lang.String Name of the branch serving as the head of the Pull Request.
title java.lang.String The title of the Pull Request.
body java.lang.String Body of the Pull Request.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/repository_pull_request#id RepositoryPullRequest#id}.
maintainerCanModify java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Controls whether the base repository maintainers can modify the Pull Request. Default: 'false'.
owner java.lang.String Owner of the repository. If not provided, the provider's default owner is used.
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
baseRefRequired 
public java.lang.String getBaseRef();
  • Type: java.lang.String

Name of the branch serving as the base of the Pull Request.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/repository_pull_request#base_ref RepositoryPullRequest#base_ref}

baseRepositoryRequired 
public java.lang.String getBaseRepository();
  • Type: java.lang.String

Name of the base repository to retrieve the Pull Requests from.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/repository_pull_request#base_repository RepositoryPullRequest#base_repository}

headRefRequired 
public java.lang.String getHeadRef();
  • Type: java.lang.String

Name of the branch serving as the head of the Pull Request.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/repository_pull_request#head_ref RepositoryPullRequest#head_ref}

titleRequired 
public java.lang.String getTitle();
  • Type: java.lang.String

The title of the Pull Request.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/repository_pull_request#title RepositoryPullRequest#title}

bodyOptional 
public java.lang.String getBody();
  • Type: java.lang.String

Body of the Pull Request.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/repository_pull_request#body RepositoryPullRequest#body}

idOptional 
public java.lang.String getId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/repository_pull_request#id RepositoryPullRequest#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

maintainerCanModifyOptional 
public java.lang.Object getMaintainerCanModify();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Controls whether the base repository maintainers can modify the Pull Request. Default: 'false'.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/repository_pull_request#maintainer_can_modify RepositoryPullRequest#maintainer_can_modify}

ownerOptional 
public java.lang.String getOwner();
  • Type: java.lang.String

Owner of the repository. If not provided, the provider's default owner is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/integrations/github/6.2.3/docs/resources/repository_pull_request#owner RepositoryPullRequest#owner}