- 0.55.0 (latest)
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.2
- 0.2.2
- 0.1.1
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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > LogsPolicyImplements
LogsPolicyOrBuilderStatic 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()
Returns | |
---|---|
Type | Description |
LogsPolicy |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static LogsPolicy.Builder newBuilder()
Returns | |
---|---|
Type | Description |
LogsPolicy.Builder |
newBuilder(LogsPolicy prototype)
public static LogsPolicy.Builder newBuilder(LogsPolicy prototype)
Parameter | |
---|---|
Name | Description |
prototype |
LogsPolicy |
Returns | |
---|---|
Type | Description |
LogsPolicy.Builder |
parseDelimitedFrom(InputStream input)
public static LogsPolicy parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
LogsPolicy |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static LogsPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
LogsPolicy |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static LogsPolicy parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data |
byte[] |
Returns | |
---|---|
Type | Description |
LogsPolicy |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static LogsPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
LogsPolicy |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static LogsPolicy parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data |
ByteString |
Returns | |
---|---|
Type | Description |
LogsPolicy |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static LogsPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
LogsPolicy |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static LogsPolicy parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
Returns | |
---|---|
Type | Description |
LogsPolicy |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static LogsPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
LogsPolicy |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static LogsPolicy parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
LogsPolicy |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static LogsPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
LogsPolicy |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static LogsPolicy parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data |
ByteBuffer |
Returns | |
---|---|
Type | Description |
LogsPolicy |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static LogsPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
LogsPolicy |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<LogsPolicy> parser()
Returns | |
---|---|
Type | Description |
Parser<LogsPolicy> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj |
Object |
Returns | |
---|---|
Type | Description |
boolean |
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];
Returns | |
---|---|
Type | Description |
LogsPolicy.CloudLoggingOption |
The cloudLoggingOption. |
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];
Returns | |
---|---|
Type | Description |
LogsPolicy.CloudLoggingOptionOrBuilder |
getDefaultInstanceForType()
public LogsPolicy getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
LogsPolicy |
getDestination()
public LogsPolicy.Destination getDestination()
If and where logs should be saved.
.google.cloud.batch.v1.LogsPolicy.Destination destination = 1;
Returns | |
---|---|
Type | Description |
LogsPolicy.Destination |
The destination. |
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()
Returns | |
---|---|
Type | Description |
Parser<LogsPolicy> |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
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()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public LogsPolicy.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
LogsPolicy.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected LogsPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent |
BuilderParent |
Returns | |
---|---|
Type | Description |
LogsPolicy.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public LogsPolicy.Builder toBuilder()
Returns | |
---|---|
Type | Description |
LogsPolicy.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output |
CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |