Send feedback
Class LogsPolicy (0.76.0)
Version latestkeyboard_arrow_down
public final class LogsPolicy extends GeneratedMessageV3 implements LogsPolicyOrBuilder
LogsPolicy describes if and how a job's logs are preserved. Logs include
information that is automatically written by the Batch service agent and any
information that you configured the job's runnables to write to the stdout
or stderr streams.
Protobuf type google.cloud.batch.v1.LogsPolicy
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CLOUD_LOGGING_OPTION_FIELD_NUMBER
public static final int CLOUD_LOGGING_OPTION_FIELD_NUMBER
Field Value
Type Description
int
DESTINATION_FIELD_NUMBER
public static final int DESTINATION_FIELD_NUMBER
Field Value
Type Description
int
LOGS_PATH_FIELD_NUMBER
public static final int LOGS_PATH_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static LogsPolicy getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static LogsPolicy . Builder newBuilder ()
newBuilder(LogsPolicy prototype)
public static LogsPolicy . Builder newBuilder ( LogsPolicy prototype )
public static LogsPolicy parseDelimitedFrom ( InputStream input )
public static LogsPolicy parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static LogsPolicy parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static LogsPolicy parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static LogsPolicy parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static LogsPolicy parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static LogsPolicy parseFrom ( CodedInputStream input )
public static LogsPolicy parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static LogsPolicy parseFrom ( InputStream input )
public static LogsPolicy parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static LogsPolicy parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static LogsPolicy parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<LogsPolicy> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getCloudLoggingOption()
public LogsPolicy . CloudLoggingOption getCloudLoggingOption ()
Optional. When destination is set to CLOUD_LOGGING, you can optionally
set this field to configure additional settings for Cloud Logging.
.google.cloud.batch.v1.LogsPolicy.CloudLoggingOption cloud_logging_option = 3 [(.google.api.field_behavior) = OPTIONAL];
getCloudLoggingOptionOrBuilder()
public LogsPolicy . CloudLoggingOptionOrBuilder getCloudLoggingOptionOrBuilder ()
Optional. When destination is set to CLOUD_LOGGING, you can optionally
set this field to configure additional settings for Cloud Logging.
.google.cloud.batch.v1.LogsPolicy.CloudLoggingOption cloud_logging_option = 3 [(.google.api.field_behavior) = OPTIONAL];
getDefaultInstanceForType()
public LogsPolicy getDefaultInstanceForType ()
getDestination()
public LogsPolicy . Destination getDestination ()
If and where logs should be saved.
.google.cloud.batch.v1.LogsPolicy.Destination destination = 1;
getDestinationValue()
public int getDestinationValue ()
If and where logs should be saved.
.google.cloud.batch.v1.LogsPolicy.Destination destination = 1;
Returns
Type Description
int The enum numeric value on the wire for destination.
getLogsPath()
public String getLogsPath ()
When destination is set to PATH, you must set this field to the path
where you want logs to be saved. This path can point to a local directory
on the VM or (if congifured) a directory under the mount path of any
Cloud Storage bucket, network file system (NFS), or writable persistent
disk that is mounted to the job. For example, if the job has a bucket with
mountPath set to /mnt/disks/my-bucket, you can write logs to the
root directory of the remotePath of that bucket by setting this field to
/mnt/disks/my-bucket/.
string logs_path = 2;
Returns
Type Description
String The logsPath.
getLogsPathBytes()
public ByteString getLogsPathBytes ()
When destination is set to PATH, you must set this field to the path
where you want logs to be saved. This path can point to a local directory
on the VM or (if congifured) a directory under the mount path of any
Cloud Storage bucket, network file system (NFS), or writable persistent
disk that is mounted to the job. For example, if the job has a bucket with
mountPath set to /mnt/disks/my-bucket, you can write logs to the
root directory of the remotePath of that bucket by setting this field to
/mnt/disks/my-bucket/.
string logs_path = 2;
Returns
Type Description
ByteString The bytes for logsPath.
getParserForType()
public Parser<LogsPolicy> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
hasCloudLoggingOption()
public boolean hasCloudLoggingOption ()
Optional. When destination is set to CLOUD_LOGGING, you can optionally
set this field to configure additional settings for Cloud Logging.
.google.cloud.batch.v1.LogsPolicy.CloudLoggingOption cloud_logging_option = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
boolean Whether the cloudLoggingOption field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public LogsPolicy . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected LogsPolicy . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public LogsPolicy . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-11 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-11 UTC."],[],[]]
