ObjectConditions (Storage Transfer API v1 (Rev. 145) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.storagetransfer.v1.model.ObjectConditions

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class ObjectConditions
extends com.google.api.client.json.GenericJson
```
Conditions that determine which objects will be transferred. Applies only to S3 and Cloud Storage objects. The "last modification time" refers to the time of the last change to the object's content or metadata — specifically, this is the `updated` property of Cloud Storage objects and the `LastModified` field of S3 objects.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Storage Transfer API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

ObjectConditions()

Constructors
Constructor and Description
`ObjectConditions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ObjectConditions`	`clone()`
`java.util.List<java.lang.String>`	`getExcludePrefixes()` `exclude_prefixes` must follow the requirements described for include_prefixes.
`java.util.List<java.lang.String>`	`getIncludePrefixes()` If `include_prefixes` is specified, objects that satisfy the object conditions must have names that start with one of the `include_prefixes` and that do not start with any of the exclude_prefixes.
`java.lang.String`	`getLastModifiedBefore()` If specified, only objects with a "last modification time" before this timestamp and objects that don't have a "last modification time" will be transferred.
`java.lang.String`	`getLastModifiedSince()` If specified, only objects with a "last modification time" on or after this timestamp and objects that don't have a "last modification time" are transferred.
`java.lang.String`	`getMaxTimeElapsedSinceLastModification()` If specified, only objects with a "last modification time" on or after `NOW` - `max_time_elapsed_since_last_modification` and objects that don't have a "last modification time" are transferred.
`java.lang.String`	`getMinTimeElapsedSinceLastModification()` If specified, only objects with a "last modification time" before `NOW` - `min_time_elapsed_since_last_modification` and objects that don't have a "last modification time" are transferred.
`ObjectConditions`	`set(java.lang.String fieldName, java.lang.Object value)`
`ObjectConditions`	`setExcludePrefixes(java.util.List<java.lang.String> excludePrefixes)` `exclude_prefixes` must follow the requirements described for include_prefixes.
`ObjectConditions`	`setIncludePrefixes(java.util.List<java.lang.String> includePrefixes)` If `include_prefixes` is specified, objects that satisfy the object conditions must have names that start with one of the `include_prefixes` and that do not start with any of the exclude_prefixes.
`ObjectConditions`	`setLastModifiedBefore(java.lang.String lastModifiedBefore)` If specified, only objects with a "last modification time" before this timestamp and objects that don't have a "last modification time" will be transferred.
`ObjectConditions`	`setLastModifiedSince(java.lang.String lastModifiedSince)` If specified, only objects with a "last modification time" on or after this timestamp and objects that don't have a "last modification time" are transferred.
`ObjectConditions`	`setMaxTimeElapsedSinceLastModification(java.lang.String maxTimeElapsedSinceLastModification)` If specified, only objects with a "last modification time" on or after `NOW` - `max_time_elapsed_since_last_modification` and objects that don't have a "last modification time" are transferred.
`ObjectConditions`	`setMinTimeElapsedSinceLastModification(java.lang.String minTimeElapsedSinceLastModification)` If specified, only objects with a "last modification time" before `NOW` - `min_time_elapsed_since_last_modification` and objects that don't have a "last modification time" are transferred.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - ObjectConditions
```
public ObjectConditions()
```
- Method Detail
  - getExcludePrefixes
```
public java.util.List<java.lang.String> getExcludePrefixes()
```
    `exclude_prefixes` must follow the requirements described for include_prefixes. The max size of `exclude_prefixes` is 1000.
    
    Returns:
    
    value or null for none
  - setExcludePrefixes
```
public ObjectConditions setExcludePrefixes(java.util.List<java.lang.String> excludePrefixes)
```
    `exclude_prefixes` must follow the requirements described for include_prefixes. The max size of `exclude_prefixes` is 1000.
    
    Parameters:
    
    excludePrefixes - excludePrefixes or null for none
  - getIncludePrefixes
```
public java.util.List<java.lang.String> getIncludePrefixes()
```
    If `include_prefixes` is specified, objects that satisfy the object conditions must have names that start with one of the `include_prefixes` and that do not start with any of the exclude_prefixes. If `include_prefixes` is not specified, all objects except those that have names starting with one of the `exclude_prefixes` must satisfy the object conditions. Requirements: * Each include-prefix and exclude-prefix can contain any sequence of Unicode characters, to a max length of 1024 bytes when UTF8-encoded, and must not contain Carriage Return or Line Feed characters. Wildcard matching and regular expression matching are not supported. * Each include-prefix and exclude-prefix must omit the leading slash. For example, to include the `requests.gz` object in a transfer from `s3://my-aws- bucket/logs/y=2015/requests.gz`, specify the include prefix as `logs/y=2015/requests.gz`. * None of the include-prefix or the exclude-prefix values can be empty, if specified. * Each include-prefix must include a distinct portion of the object namespace. No include-prefix may be a prefix of another include-prefix. * Each exclude-prefix must exclude a distinct portion of the object namespace. No exclude-prefix may be a prefix of another exclude-prefix. * If `include_prefixes` is specified, then each exclude-prefix must start with the value of a path explicitly included by `include_prefixes`. The max size of `include_prefixes` is 1000.
    
    Returns:
    
    value or null for none
  - setIncludePrefixes
```
public ObjectConditions setIncludePrefixes(java.util.List<java.lang.String> includePrefixes)
```
    If `include_prefixes` is specified, objects that satisfy the object conditions must have names that start with one of the `include_prefixes` and that do not start with any of the exclude_prefixes. If `include_prefixes` is not specified, all objects except those that have names starting with one of the `exclude_prefixes` must satisfy the object conditions. Requirements: * Each include-prefix and exclude-prefix can contain any sequence of Unicode characters, to a max length of 1024 bytes when UTF8-encoded, and must not contain Carriage Return or Line Feed characters. Wildcard matching and regular expression matching are not supported. * Each include-prefix and exclude-prefix must omit the leading slash. For example, to include the `requests.gz` object in a transfer from `s3://my-aws- bucket/logs/y=2015/requests.gz`, specify the include prefix as `logs/y=2015/requests.gz`. * None of the include-prefix or the exclude-prefix values can be empty, if specified. * Each include-prefix must include a distinct portion of the object namespace. No include-prefix may be a prefix of another include-prefix. * Each exclude-prefix must exclude a distinct portion of the object namespace. No exclude-prefix may be a prefix of another exclude-prefix. * If `include_prefixes` is specified, then each exclude-prefix must start with the value of a path explicitly included by `include_prefixes`. The max size of `include_prefixes` is 1000.
    
    Parameters:
    
    includePrefixes - includePrefixes or null for none
  - getLastModifiedBefore
```
public java.lang.String getLastModifiedBefore()
```
    If specified, only objects with a "last modification time" before this timestamp and objects that don't have a "last modification time" will be transferred.
    
    Returns:
    
    value or null for none
  - setLastModifiedBefore
```
public ObjectConditions setLastModifiedBefore(java.lang.String lastModifiedBefore)
```
    If specified, only objects with a "last modification time" before this timestamp and objects that don't have a "last modification time" will be transferred.
    
    Parameters:
    
    lastModifiedBefore - lastModifiedBefore or null for none
  - getLastModifiedSince
```
public java.lang.String getLastModifiedSince()
```
    If specified, only objects with a "last modification time" on or after this timestamp and objects that don't have a "last modification time" are transferred. The `last_modified_since` and `last_modified_before` fields can be used together for chunked data processing. For example, consider a script that processes each day's worth of data at a time. For that you'd set each of the fields as follows: * `last_modified_since` to the start of the day * `last_modified_before` to the end of the day
    
    Returns:
    
    value or null for none
  - setLastModifiedSince
```
public ObjectConditions setLastModifiedSince(java.lang.String lastModifiedSince)
```
    If specified, only objects with a "last modification time" on or after this timestamp and objects that don't have a "last modification time" are transferred. The `last_modified_since` and `last_modified_before` fields can be used together for chunked data processing. For example, consider a script that processes each day's worth of data at a time. For that you'd set each of the fields as follows: * `last_modified_since` to the start of the day * `last_modified_before` to the end of the day
    
    Parameters:
    
    lastModifiedSince - lastModifiedSince or null for none
  - getMaxTimeElapsedSinceLastModification
```
public java.lang.String getMaxTimeElapsedSinceLastModification()
```
    If specified, only objects with a "last modification time" on or after `NOW` - `max_time_elapsed_since_last_modification` and objects that don't have a "last modification time" are transferred. For each TransferOperation started by this TransferJob, `NOW` refers to the start_time of the `TransferOperation`.
    
    Returns:
    
    value or null for none
  - setMaxTimeElapsedSinceLastModification
```
public ObjectConditions setMaxTimeElapsedSinceLastModification(java.lang.String maxTimeElapsedSinceLastModification)
```
    If specified, only objects with a "last modification time" on or after `NOW` - `max_time_elapsed_since_last_modification` and objects that don't have a "last modification time" are transferred. For each TransferOperation started by this TransferJob, `NOW` refers to the start_time of the `TransferOperation`.
    
    Parameters:
    
    maxTimeElapsedSinceLastModification - maxTimeElapsedSinceLastModification or null for none
  - getMinTimeElapsedSinceLastModification
```
public java.lang.String getMinTimeElapsedSinceLastModification()
```
    If specified, only objects with a "last modification time" before `NOW` - `min_time_elapsed_since_last_modification` and objects that don't have a "last modification time" are transferred. For each TransferOperation started by this TransferJob, `NOW` refers to the start_time of the `TransferOperation`.
    
    Returns:
    
    value or null for none
  - setMinTimeElapsedSinceLastModification
```
public ObjectConditions setMinTimeElapsedSinceLastModification(java.lang.String minTimeElapsedSinceLastModification)
```
    If specified, only objects with a "last modification time" before `NOW` - `min_time_elapsed_since_last_modification` and objects that don't have a "last modification time" are transferred. For each TransferOperation started by this TransferJob, `NOW` refers to the start_time of the `TransferOperation`.
    
    Parameters:
    
    minTimeElapsedSinceLastModification - minTimeElapsedSinceLastModification or null for none
  - set
```
public ObjectConditions set(java.lang.String fieldName,
                            java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public ObjectConditions clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Storage Transfer API v1 (revision 145)

Class ObjectConditions

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

ObjectConditions

Method Detail

getExcludePrefixes

setExcludePrefixes

getIncludePrefixes

setIncludePrefixes

getLastModifiedBefore

setLastModifiedBefore

getLastModifiedSince

setLastModifiedSince

getMaxTimeElapsedSinceLastModification

setMaxTimeElapsedSinceLastModification

getMinTimeElapsedSinceLastModification

setMinTimeElapsedSinceLastModification

set

clone