com.google.maps.addressvalidation.v1

Class ValidateAddressRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<ValidateAddressRequest.Builder>

com.google.maps.addressvalidation.v1.ValidateAddressRequest.Builder

All Implemented Interfaces:

ValidateAddressRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

ValidateAddressRequest

public static final class ValidateAddressRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ValidateAddressRequest.Builder>
implements ValidateAddressRequestOrBuilder

 The request for validating an address.
 

Protobuf type google.maps.addressvalidation.v1.ValidateAddressRequest

Method Summary

Modifier and Type	Method and Description
ValidateAddressRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ValidateAddressRequest	build()
ValidateAddressRequest	buildPartial()
ValidateAddressRequest.Builder	clear()
ValidateAddressRequest.Builder	clearAddress() Required.
ValidateAddressRequest.Builder	clearEnableUspsCass() Enables USPS CASS compatible mode.
ValidateAddressRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
ValidateAddressRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
ValidateAddressRequest.Builder	clearPreviousResponseId() This field must be empty for the first address validation request.
ValidateAddressRequest.Builder	clone()
com.google.type.PostalAddress	getAddress() Required.
com.google.type.PostalAddress.Builder	getAddressBuilder() Required.
com.google.type.PostalAddressOrBuilder	getAddressOrBuilder() Required.
ValidateAddressRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
boolean	getEnableUspsCass() Enables USPS CASS compatible mode.
String	getPreviousResponseId() This field must be empty for the first address validation request.
com.google.protobuf.ByteString	getPreviousResponseIdBytes() This field must be empty for the first address validation request.
boolean	hasAddress() Required.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ValidateAddressRequest.Builder	mergeAddress(com.google.type.PostalAddress value) Required.
ValidateAddressRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ValidateAddressRequest.Builder	mergeFrom(com.google.protobuf.Message other)
ValidateAddressRequest.Builder	mergeFrom(ValidateAddressRequest other)
ValidateAddressRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
ValidateAddressRequest.Builder	setAddress(com.google.type.PostalAddress.Builder builderForValue) Required.
ValidateAddressRequest.Builder	setAddress(com.google.type.PostalAddress value) Required.
ValidateAddressRequest.Builder	setEnableUspsCass(boolean value) Enables USPS CASS compatible mode.
ValidateAddressRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ValidateAddressRequest.Builder	setPreviousResponseId(String value) This field must be empty for the first address validation request.
ValidateAddressRequest.Builder	setPreviousResponseIdBytes(com.google.protobuf.ByteString value) This field must be empty for the first address validation request.
ValidateAddressRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
ValidateAddressRequest.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ValidateAddressRequest.Builder>

clear

public ValidateAddressRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<ValidateAddressRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ValidateAddressRequest.Builder>

getDefaultInstanceForType

public ValidateAddressRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public ValidateAddressRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public ValidateAddressRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public ValidateAddressRequest.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<ValidateAddressRequest.Builder>

setField

public ValidateAddressRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<ValidateAddressRequest.Builder>

clearField

public ValidateAddressRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ValidateAddressRequest.Builder>

clearOneof

public ValidateAddressRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ValidateAddressRequest.Builder>

setRepeatedField

public ValidateAddressRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                       int index,
                                                       Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ValidateAddressRequest.Builder>

addRepeatedField

public ValidateAddressRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                       Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ValidateAddressRequest.Builder>

mergeFrom

public ValidateAddressRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ValidateAddressRequest.Builder>

mergeFrom

public ValidateAddressRequest.Builder mergeFrom(ValidateAddressRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ValidateAddressRequest.Builder>

mergeFrom

public ValidateAddressRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ValidateAddressRequest.Builder>

Throws:

IOException

hasAddress

public boolean hasAddress()

 Required. The address being validated. Unformatted addresses should be
 submitted via [`address_lines`][google.type.PostalAddress.address_lines].

 The total length of the fields in this input must not exceed 280
 characters.

 Supported regions can be found in the
 [FAQ](https://developers.google.com/maps/documentation/address-validation/faq#which_regions_are_currently_supported).

 The [language_code][google.type.PostalAddress.language_code] value in the
 input address is reserved for future uses and is ignored today. The
 validated address result will be populated based on the preferred language
 for the given address, as identified by the system.

 The Address Validation API ignores the values in
 [recipients][google.type.PostalAddress.recipients] and
 [organization][google.type.PostalAddress.organization]. Any values in those
 fields will be discarded and not returned. Please do not set them.
 

.google.type.PostalAddress address = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

hasAddress in interface ValidateAddressRequestOrBuilder

Returns:

Whether the address field is set.

getAddress

public com.google.type.PostalAddress getAddress()

 Required. The address being validated. Unformatted addresses should be
 submitted via [`address_lines`][google.type.PostalAddress.address_lines].

 The total length of the fields in this input must not exceed 280
 characters.

 Supported regions can be found in the
 [FAQ](https://developers.google.com/maps/documentation/address-validation/faq#which_regions_are_currently_supported).

 The [language_code][google.type.PostalAddress.language_code] value in the
 input address is reserved for future uses and is ignored today. The
 validated address result will be populated based on the preferred language
 for the given address, as identified by the system.

 The Address Validation API ignores the values in
 [recipients][google.type.PostalAddress.recipients] and
 [organization][google.type.PostalAddress.organization]. Any values in those
 fields will be discarded and not returned. Please do not set them.
 

.google.type.PostalAddress address = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getAddress in interface ValidateAddressRequestOrBuilder

Returns:

The address.

setAddress

public ValidateAddressRequest.Builder setAddress(com.google.type.PostalAddress value)

 Required. The address being validated. Unformatted addresses should be
 submitted via [`address_lines`][google.type.PostalAddress.address_lines].

 The total length of the fields in this input must not exceed 280
 characters.

 Supported regions can be found in the
 [FAQ](https://developers.google.com/maps/documentation/address-validation/faq#which_regions_are_currently_supported).

 The [language_code][google.type.PostalAddress.language_code] value in the
 input address is reserved for future uses and is ignored today. The
 validated address result will be populated based on the preferred language
 for the given address, as identified by the system.

 The Address Validation API ignores the values in
 [recipients][google.type.PostalAddress.recipients] and
 [organization][google.type.PostalAddress.organization]. Any values in those
 fields will be discarded and not returned. Please do not set them.
 

.google.type.PostalAddress address = 1 [(.google.api.field_behavior) = REQUIRED];

setAddress

public ValidateAddressRequest.Builder setAddress(com.google.type.PostalAddress.Builder builderForValue)

 Required. The address being validated. Unformatted addresses should be
 submitted via [`address_lines`][google.type.PostalAddress.address_lines].

 The total length of the fields in this input must not exceed 280
 characters.

 Supported regions can be found in the
 [FAQ](https://developers.google.com/maps/documentation/address-validation/faq#which_regions_are_currently_supported).

 The [language_code][google.type.PostalAddress.language_code] value in the
 input address is reserved for future uses and is ignored today. The
 validated address result will be populated based on the preferred language
 for the given address, as identified by the system.

 The Address Validation API ignores the values in
 [recipients][google.type.PostalAddress.recipients] and
 [organization][google.type.PostalAddress.organization]. Any values in those
 fields will be discarded and not returned. Please do not set them.
 

.google.type.PostalAddress address = 1 [(.google.api.field_behavior) = REQUIRED];

mergeAddress

public ValidateAddressRequest.Builder mergeAddress(com.google.type.PostalAddress value)

 Required. The address being validated. Unformatted addresses should be
 submitted via [`address_lines`][google.type.PostalAddress.address_lines].

 The total length of the fields in this input must not exceed 280
 characters.

 Supported regions can be found in the
 [FAQ](https://developers.google.com/maps/documentation/address-validation/faq#which_regions_are_currently_supported).

 The [language_code][google.type.PostalAddress.language_code] value in the
 input address is reserved for future uses and is ignored today. The
 validated address result will be populated based on the preferred language
 for the given address, as identified by the system.

 The Address Validation API ignores the values in
 [recipients][google.type.PostalAddress.recipients] and
 [organization][google.type.PostalAddress.organization]. Any values in those
 fields will be discarded and not returned. Please do not set them.
 

.google.type.PostalAddress address = 1 [(.google.api.field_behavior) = REQUIRED];

clearAddress

public ValidateAddressRequest.Builder clearAddress()

 Required. The address being validated. Unformatted addresses should be
 submitted via [`address_lines`][google.type.PostalAddress.address_lines].

 The total length of the fields in this input must not exceed 280
 characters.

 Supported regions can be found in the
 [FAQ](https://developers.google.com/maps/documentation/address-validation/faq#which_regions_are_currently_supported).

 The [language_code][google.type.PostalAddress.language_code] value in the
 input address is reserved for future uses and is ignored today. The
 validated address result will be populated based on the preferred language
 for the given address, as identified by the system.

 The Address Validation API ignores the values in
 [recipients][google.type.PostalAddress.recipients] and
 [organization][google.type.PostalAddress.organization]. Any values in those
 fields will be discarded and not returned. Please do not set them.
 

.google.type.PostalAddress address = 1 [(.google.api.field_behavior) = REQUIRED];

getAddressBuilder

public com.google.type.PostalAddress.Builder getAddressBuilder()

 Required. The address being validated. Unformatted addresses should be
 submitted via [`address_lines`][google.type.PostalAddress.address_lines].

 The total length of the fields in this input must not exceed 280
 characters.

 Supported regions can be found in the
 [FAQ](https://developers.google.com/maps/documentation/address-validation/faq#which_regions_are_currently_supported).

 The [language_code][google.type.PostalAddress.language_code] value in the
 input address is reserved for future uses and is ignored today. The
 validated address result will be populated based on the preferred language
 for the given address, as identified by the system.

 The Address Validation API ignores the values in
 [recipients][google.type.PostalAddress.recipients] and
 [organization][google.type.PostalAddress.organization]. Any values in those
 fields will be discarded and not returned. Please do not set them.
 

.google.type.PostalAddress address = 1 [(.google.api.field_behavior) = REQUIRED];

getAddressOrBuilder

public com.google.type.PostalAddressOrBuilder getAddressOrBuilder()

 Required. The address being validated. Unformatted addresses should be
 submitted via [`address_lines`][google.type.PostalAddress.address_lines].

 The total length of the fields in this input must not exceed 280
 characters.

 Supported regions can be found in the
 [FAQ](https://developers.google.com/maps/documentation/address-validation/faq#which_regions_are_currently_supported).

 The [language_code][google.type.PostalAddress.language_code] value in the
 input address is reserved for future uses and is ignored today. The
 validated address result will be populated based on the preferred language
 for the given address, as identified by the system.

 The Address Validation API ignores the values in
 [recipients][google.type.PostalAddress.recipients] and
 [organization][google.type.PostalAddress.organization]. Any values in those
 fields will be discarded and not returned. Please do not set them.
 

.google.type.PostalAddress address = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getAddressOrBuilder in interface ValidateAddressRequestOrBuilder

getPreviousResponseId

public String getPreviousResponseId()

 This field must be empty for the first address validation request. If
 more requests are necessary to fully validate a single address (for
 example if the changes the user makes after the initial validation need to
 be re-validated), then each followup request must populate this field with
 the
 [response_id][google.maps.addressvalidation.v1.ValidateAddressResponse.response_id]
 from the very first response in the validation sequence.
 

string previous_response_id = 2;

Specified by:

getPreviousResponseId in interface ValidateAddressRequestOrBuilder

Returns:

The previousResponseId.

getPreviousResponseIdBytes

public com.google.protobuf.ByteString getPreviousResponseIdBytes()

 This field must be empty for the first address validation request. If
 more requests are necessary to fully validate a single address (for
 example if the changes the user makes after the initial validation need to
 be re-validated), then each followup request must populate this field with
 the
 [response_id][google.maps.addressvalidation.v1.ValidateAddressResponse.response_id]
 from the very first response in the validation sequence.
 

string previous_response_id = 2;

Specified by:

getPreviousResponseIdBytes in interface ValidateAddressRequestOrBuilder

Returns:

The bytes for previousResponseId.

setPreviousResponseId

public ValidateAddressRequest.Builder setPreviousResponseId(String value)

 This field must be empty for the first address validation request. If
 more requests are necessary to fully validate a single address (for
 example if the changes the user makes after the initial validation need to
 be re-validated), then each followup request must populate this field with
 the
 [response_id][google.maps.addressvalidation.v1.ValidateAddressResponse.response_id]
 from the very first response in the validation sequence.
 

string previous_response_id = 2;

Parameters:

value - The previousResponseId to set.

Returns:

This builder for chaining.

clearPreviousResponseId

public ValidateAddressRequest.Builder clearPreviousResponseId()

 This field must be empty for the first address validation request. If
 more requests are necessary to fully validate a single address (for
 example if the changes the user makes after the initial validation need to
 be re-validated), then each followup request must populate this field with
 the
 [response_id][google.maps.addressvalidation.v1.ValidateAddressResponse.response_id]
 from the very first response in the validation sequence.
 

string previous_response_id = 2;

Returns:

This builder for chaining.

setPreviousResponseIdBytes

public ValidateAddressRequest.Builder setPreviousResponseIdBytes(com.google.protobuf.ByteString value)

 This field must be empty for the first address validation request. If
 more requests are necessary to fully validate a single address (for
 example if the changes the user makes after the initial validation need to
 be re-validated), then each followup request must populate this field with
 the
 [response_id][google.maps.addressvalidation.v1.ValidateAddressResponse.response_id]
 from the very first response in the validation sequence.
 

string previous_response_id = 2;

Parameters:

value - The bytes for previousResponseId to set.

Returns:

This builder for chaining.

getEnableUspsCass

public boolean getEnableUspsCass()

 Enables USPS CASS compatible mode. This affects _only_ the
 [google.maps.addressvalidation.v1.ValidationResult.usps_data] field of
 [google.maps.addressvalidation.v1.ValidationResult]. Note: for USPS CASS
 enabled requests for addresses in Puerto Rico, a
 [google.type.PostalAddress.region_code] of the `address` must be provided
 as "PR", or an [google.type.PostalAddress.administrative_area] of the
 `address` must be provided as "Puerto Rico" (case-insensitive) or "PR".

 It's recommended to use a componentized `address`, or alternatively specify
 at least two [google.type.PostalAddress.address_lines] where the first line
 contains the street number and name and the second line contains the city,
 state, and zip code.
 

bool enable_usps_cass = 3;

Specified by:

getEnableUspsCass in interface ValidateAddressRequestOrBuilder

Returns:

The enableUspsCass.

setEnableUspsCass

public ValidateAddressRequest.Builder setEnableUspsCass(boolean value)

 Enables USPS CASS compatible mode. This affects _only_ the
 [google.maps.addressvalidation.v1.ValidationResult.usps_data] field of
 [google.maps.addressvalidation.v1.ValidationResult]. Note: for USPS CASS
 enabled requests for addresses in Puerto Rico, a
 [google.type.PostalAddress.region_code] of the `address` must be provided
 as "PR", or an [google.type.PostalAddress.administrative_area] of the
 `address` must be provided as "Puerto Rico" (case-insensitive) or "PR".

 It's recommended to use a componentized `address`, or alternatively specify
 at least two [google.type.PostalAddress.address_lines] where the first line
 contains the street number and name and the second line contains the city,
 state, and zip code.
 

bool enable_usps_cass = 3;

Parameters:

value - The enableUspsCass to set.

Returns:

This builder for chaining.

clearEnableUspsCass

public ValidateAddressRequest.Builder clearEnableUspsCass()

 Enables USPS CASS compatible mode. This affects _only_ the
 [google.maps.addressvalidation.v1.ValidationResult.usps_data] field of
 [google.maps.addressvalidation.v1.ValidationResult]. Note: for USPS CASS
 enabled requests for addresses in Puerto Rico, a
 [google.type.PostalAddress.region_code] of the `address` must be provided
 as "PR", or an [google.type.PostalAddress.administrative_area] of the
 `address` must be provided as "Puerto Rico" (case-insensitive) or "PR".

 It's recommended to use a componentized `address`, or alternatively specify
 at least two [google.type.PostalAddress.address_lines] where the first line
 contains the street number and name and the second line contains the city,
 state, and zip code.
 

bool enable_usps_cass = 3;

Returns:

This builder for chaining.

setUnknownFields

public final ValidateAddressRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ValidateAddressRequest.Builder>

mergeUnknownFields

public final ValidateAddressRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ValidateAddressRequest.Builder>