Class GuestPolicies.SoftwareRecipe.Step.CopyFile (2.34.0)

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

Copies the artifact to the specified path on the instance.

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > GuestPolicies.SoftwareRecipe.Step.CopyFile

Static Fields

ARTIFACT_ID_FIELD_NUMBER

public static final int ARTIFACT_ID_FIELD_NUMBER
Field Value
TypeDescription
int

DESTINATION_FIELD_NUMBER

public static final int DESTINATION_FIELD_NUMBER
Field Value
TypeDescription
int

OVERWRITE_FIELD_NUMBER

public static final int OVERWRITE_FIELD_NUMBER
Field Value
TypeDescription
int

PERMISSIONS_FIELD_NUMBER

public static final int PERMISSIONS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static GuestPolicies.SoftwareRecipe.Step.CopyFile getDefaultInstance()
Returns
TypeDescription
GuestPolicies.SoftwareRecipe.Step.CopyFile

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder newBuilder()
Returns
TypeDescription
GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder

newBuilder(GuestPolicies.SoftwareRecipe.Step.CopyFile prototype)

public static GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder newBuilder(GuestPolicies.SoftwareRecipe.Step.CopyFile prototype)
Parameter
NameDescription
prototypeGuestPolicies.SoftwareRecipe.Step.CopyFile
Returns
TypeDescription
GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder

parseDelimitedFrom(InputStream input)

public static GuestPolicies.SoftwareRecipe.Step.CopyFile parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
GuestPolicies.SoftwareRecipe.Step.CopyFile
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GuestPolicies.SoftwareRecipe.Step.CopyFile parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GuestPolicies.SoftwareRecipe.Step.CopyFile
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static GuestPolicies.SoftwareRecipe.Step.CopyFile parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
GuestPolicies.SoftwareRecipe.Step.CopyFile
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GuestPolicies.SoftwareRecipe.Step.CopyFile parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GuestPolicies.SoftwareRecipe.Step.CopyFile
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GuestPolicies.SoftwareRecipe.Step.CopyFile parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
GuestPolicies.SoftwareRecipe.Step.CopyFile
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GuestPolicies.SoftwareRecipe.Step.CopyFile parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GuestPolicies.SoftwareRecipe.Step.CopyFile
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GuestPolicies.SoftwareRecipe.Step.CopyFile parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
GuestPolicies.SoftwareRecipe.Step.CopyFile
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GuestPolicies.SoftwareRecipe.Step.CopyFile parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GuestPolicies.SoftwareRecipe.Step.CopyFile
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static GuestPolicies.SoftwareRecipe.Step.CopyFile parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
GuestPolicies.SoftwareRecipe.Step.CopyFile
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GuestPolicies.SoftwareRecipe.Step.CopyFile parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GuestPolicies.SoftwareRecipe.Step.CopyFile
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static GuestPolicies.SoftwareRecipe.Step.CopyFile parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
GuestPolicies.SoftwareRecipe.Step.CopyFile
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GuestPolicies.SoftwareRecipe.Step.CopyFile parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GuestPolicies.SoftwareRecipe.Step.CopyFile
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<GuestPolicies.SoftwareRecipe.Step.CopyFile> parser()
Returns
TypeDescription
Parser<CopyFile>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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
TypeDescription
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
TypeDescription
ByteString

The bytes for artifactId.

getDefaultInstanceForType()

public GuestPolicies.SoftwareRecipe.Step.CopyFile getDefaultInstanceForType()
Returns
TypeDescription
GuestPolicies.SoftwareRecipe.Step.CopyFile

getDestination()

public String getDestination()

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

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

The overwrite.

getParserForType()

public Parser<GuestPolicies.SoftwareRecipe.Step.CopyFile> getParserForType()
Returns
TypeDescription
Parser<CopyFile>
Overrides

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
TypeDescription
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
TypeDescription
ByteString

The bytes for permissions.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder newBuilderForType()
Returns
TypeDescription
GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder toBuilder()
Returns
TypeDescription
GuestPolicies.SoftwareRecipe.Step.CopyFile.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException