UploadBatchServiceLogsParameters Class

Package:
com.azure.compute.batch.models
Maven Artifact:
com.azure:azure-compute-batch:1.0.0-beta.6
  • java.lang.Object
    • com.azure.compute.batch.models.UploadBatchServiceLogsParameters

Implements

JsonSerializable<UploadBatchServiceLogsParameters>

public final class UploadBatchServiceLogsParameters
implements JsonSerializable<UploadBatchServiceLogsParameters>

The Azure Batch service log files upload parameters for a Compute Node.

Constructor Summary

Constructor Description
UploadBatchServiceLogsParameters(String containerUrl, OffsetDateTime startTime)

Creates an instance of UploadBatchServiceLogsParameters class.

Method Summary

Modifier and Type Method and Description
static UploadBatchServiceLogsParameters fromJson(JsonReader jsonReader)

Reads an instance of UploadBatchServiceLogsParameters from the JsonReader.
String getContainerUrl()

Get the containerUrl property: The URL of the container within Azure Blob Storage to which to upload the Batch Service log file(s).
OffsetDateTime getEndTime()

Get the endTime property: The end of the time range from which to upload Batch Service log file(s).
BatchNodeIdentityReference getIdentityReference()

Get the identityReference property: The reference to the user assigned identity to use to access Azure Blob Storage specified by containerUrl.
OffsetDateTime getStartTime()

Get the startTime property: The start of the time range from which to upload Batch Service log file(s).
UploadBatchServiceLogsParameters setEndTime(OffsetDateTime endTime)

Set the endTime property: The end of the time range from which to upload Batch Service log file(s).
UploadBatchServiceLogsParameters setIdentityReference(BatchNodeIdentityReference identityReference)

Set the identityReference property: The reference to the user assigned identity to use to access Azure Blob Storage specified by containerUrl.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

UploadBatchServiceLogsParameters

public UploadBatchServiceLogsParameters(String containerUrl, OffsetDateTime startTime)

Creates an instance of UploadBatchServiceLogsParameters class.

Parameters:

containerUrl - the containerUrl value to set.
startTime - the startTime value to set.

Method Details

fromJson

public static UploadBatchServiceLogsParameters fromJson(JsonReader jsonReader)

Reads an instance of UploadBatchServiceLogsParameters from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of UploadBatchServiceLogsParameters if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getContainerUrl

public String getContainerUrl()

Get the containerUrl property: The URL of the container within Azure Blob Storage to which to upload the Batch Service log file(s). If a user assigned managed identity is not being used, the URL must include a Shared Access Signature (SAS) granting write permissions to the container. The SAS duration must allow enough time for the upload to finish. The start time for SAS is optional and recommended to not be specified.

Returns:

the containerUrl value.

getEndTime

public OffsetDateTime getEndTime()

Get the endTime property: The end of the time range from which to upload Batch Service log file(s). Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded, but the operation should not retrieve fewer logs than have been requested. If omitted, the default is to upload all logs available after the startTime.

Returns:

the endTime value.

getIdentityReference

public BatchNodeIdentityReference getIdentityReference()

Get the identityReference property: The reference to the user assigned identity to use to access Azure Blob Storage specified by containerUrl. The identity must have write access to the Azure Blob Storage container.

Returns:

the identityReference value.

getStartTime

public OffsetDateTime getStartTime()

Get the startTime property: The start of the time range from which to upload Batch Service log file(s). Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded, but the operation should not retrieve fewer logs than have been requested.

Returns:

the startTime value.

setEndTime

public UploadBatchServiceLogsParameters setEndTime(OffsetDateTime endTime)

Set the endTime property: The end of the time range from which to upload Batch Service log file(s). Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded, but the operation should not retrieve fewer logs than have been requested. If omitted, the default is to upload all logs available after the startTime.

Parameters:

endTime - the endTime value to set.

Returns:

the UploadBatchServiceLogsParameters object itself.

setIdentityReference

public UploadBatchServiceLogsParameters setIdentityReference(BatchNodeIdentityReference identityReference)

Set the identityReference property: The reference to the user assigned identity to use to access Azure Blob Storage specified by containerUrl. The identity must have write access to the Azure Blob Storage container.

Parameters:

identityReference - the identityReference value to set.

Returns:

the UploadBatchServiceLogsParameters object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to