Class GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder (2.46.0)

public static final class GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder extends GeneratedMessageV3.Builder<GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder> implements GuestPolicies.SoftwareRecipe.Step.CopyFileOrBuilder

Copies the artifact to the specified path on the instance.

Protobuf type google.cloud.osconfig.v1beta.SoftwareRecipe.Step.CopyFile

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder
Overrides

build()

public GuestPolicies.SoftwareRecipe.Step.CopyFile build()
Returns
Type Description
GuestPolicies.SoftwareRecipe.Step.CopyFile

buildPartial()

public GuestPolicies.SoftwareRecipe.Step.CopyFile buildPartial()
Returns
Type Description
GuestPolicies.SoftwareRecipe.Step.CopyFile

clear()

public GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder clear()
Returns
Type Description
GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder
Overrides

clearArtifactId()

public GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder clearArtifactId()

Required. The id of the relevant artifact in the recipe.

string artifact_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder

This builder for chaining.

clearDestination()

public GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder clearDestination()

Required. The absolute path on the instance to put the file.

string destination = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder
Overrides

clearOverwrite()

public GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder clearOverwrite()

Whether to allow this step to overwrite existing files. If this is false and the file already exists the file is not overwritten and the step is considered a success. Defaults to false.

bool overwrite = 3;

Returns
Type Description
GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder

This builder for chaining.

clearPermissions()

public GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder clearPermissions()

Consists of three octal digits which represent, in order, the permissions of the owner, group, and other users for the file (similarly to the numeric mode used in the linux chmod utility). Each digit represents a three bit number with the 4 bit corresponding to the read permissions, the 2 bit corresponds to the write bit, and the one bit corresponds to the execute permission. Default behavior is 755.

Below are some examples of permissions and their associated values: read, write, and execute: 7 read and execute: 5 read and write: 6 read only: 4

string permissions = 4;

Returns
Type Description
GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder

This builder for chaining.

clone()

public GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder clone()
Returns
Type Description
GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder
Overrides

getArtifactId()

public String getArtifactId()

Required. The id of the relevant artifact in the recipe.

string artifact_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The artifactId.

getArtifactIdBytes()

public ByteString getArtifactIdBytes()

Required. The id of the relevant artifact in the recipe.

string artifact_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for artifactId.

getDefaultInstanceForType()

public GuestPolicies.SoftwareRecipe.Step.CopyFile getDefaultInstanceForType()
Returns
Type Description
GuestPolicies.SoftwareRecipe.Step.CopyFile

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDestination()

public String getDestination()

Required. The absolute path on the instance to put the file.

string destination = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The destination.

getDestinationBytes()

public ByteString getDestinationBytes()

Required. The absolute path on the instance to put the file.

string destination = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for destination.

getOverwrite()

public boolean getOverwrite()

Whether to allow this step to overwrite existing files. If this is false and the file already exists the file is not overwritten and the step is considered a success. Defaults to false.

bool overwrite = 3;

Returns
Type Description
boolean

The overwrite.

getPermissions()

public String getPermissions()

Consists of three octal digits which represent, in order, the permissions of the owner, group, and other users for the file (similarly to the numeric mode used in the linux chmod utility). Each digit represents a three bit number with the 4 bit corresponding to the read permissions, the 2 bit corresponds to the write bit, and the one bit corresponds to the execute permission. Default behavior is 755.

Below are some examples of permissions and their associated values: read, write, and execute: 7 read and execute: 5 read and write: 6 read only: 4

string permissions = 4;

Returns
Type Description
String

The permissions.

getPermissionsBytes()

public ByteString getPermissionsBytes()

Consists of three octal digits which represent, in order, the permissions of the owner, group, and other users for the file (similarly to the numeric mode used in the linux chmod utility). Each digit represents a three bit number with the 4 bit corresponding to the read permissions, the 2 bit corresponds to the write bit, and the one bit corresponds to the execute permission. Default behavior is 755.

Below are some examples of permissions and their associated values: read, write, and execute: 7 read and execute: 5 read and write: 6 read only: 4

string permissions = 4;

Returns
Type Description
ByteString

The bytes for permissions.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(GuestPolicies.SoftwareRecipe.Step.CopyFile other)

public GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder mergeFrom(GuestPolicies.SoftwareRecipe.Step.CopyFile other)
Parameter
Name Description
other GuestPolicies.SoftwareRecipe.Step.CopyFile
Returns
Type Description
GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder
Overrides

setArtifactId(String value)

public GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder setArtifactId(String value)

Required. The id of the relevant artifact in the recipe.

string artifact_id = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The artifactId to set.

Returns
Type Description
GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder

This builder for chaining.

setArtifactIdBytes(ByteString value)

public GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder setArtifactIdBytes(ByteString value)

Required. The id of the relevant artifact in the recipe.

string artifact_id = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for artifactId to set.

Returns
Type Description
GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder

This builder for chaining.

setDestination(String value)

public GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder setDestination(String value)

Required. The absolute path on the instance to put the file.

string destination = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The destination to set.

Returns
Type Description
GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder

This builder for chaining.

setDestinationBytes(ByteString value)

public GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder setDestinationBytes(ByteString value)

Required. The absolute path on the instance to put the file.

string destination = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for destination to set.

Returns
Type Description
GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder
Overrides

setOverwrite(boolean value)

public GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder setOverwrite(boolean value)

Whether to allow this step to overwrite existing files. If this is false and the file already exists the file is not overwritten and the step is considered a success. Defaults to false.

bool overwrite = 3;

Parameter
Name Description
value boolean

The overwrite to set.

Returns
Type Description
GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder

This builder for chaining.

setPermissions(String value)

public GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder setPermissions(String value)

Consists of three octal digits which represent, in order, the permissions of the owner, group, and other users for the file (similarly to the numeric mode used in the linux chmod utility). Each digit represents a three bit number with the 4 bit corresponding to the read permissions, the 2 bit corresponds to the write bit, and the one bit corresponds to the execute permission. Default behavior is 755.

Below are some examples of permissions and their associated values: read, write, and execute: 7 read and execute: 5 read and write: 6 read only: 4

string permissions = 4;

Parameter
Name Description
value String

The permissions to set.

Returns
Type Description
GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder

This builder for chaining.

setPermissionsBytes(ByteString value)

public GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder setPermissionsBytes(ByteString value)

Consists of three octal digits which represent, in order, the permissions of the owner, group, and other users for the file (similarly to the numeric mode used in the linux chmod utility). Each digit represents a three bit number with the 4 bit corresponding to the read permissions, the 2 bit corresponds to the write bit, and the one bit corresponds to the execute permission. Default behavior is 755.

Below are some examples of permissions and their associated values: read, write, and execute: 7 read and execute: 5 read and write: 6 read only: 4

string permissions = 4;

Parameter
Name Description
value ByteString

The bytes for permissions to set.

Returns
Type Description
GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder
Overrides