Interface SiteOrBuilder (0.9.0) 

public interface SiteOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Optional. Labels associated with this site as key value pairs. For more information about labels, see Create and manage labels.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getAccessTimes(int index)

public abstract TimePeriod getAccessTimes(int index)

Optional. The time periods when the site is accessible. If this field is empty, the site is accessible at all times.

This field is used by Google to schedule the initial installation as well as any later hardware maintenance. You may update this at any time. For example, if the initial installation is requested during off-hours but maintenance should be performed during regular business hours, you should update the access times after initial installation is complete.

repeated .google.cloud.gdchardwaremanagement.v1alpha.TimePeriod access_times = 26 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
TimePeriod

getAccessTimesCount()

public abstract int getAccessTimesCount()

Optional. The time periods when the site is accessible. If this field is empty, the site is accessible at all times.

This field is used by Google to schedule the initial installation as well as any later hardware maintenance. You may update this at any time. For example, if the initial installation is requested during off-hours but maintenance should be performed during regular business hours, you should update the access times after initial installation is complete.

repeated .google.cloud.gdchardwaremanagement.v1alpha.TimePeriod access_times = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getAccessTimesList()

public abstract List<TimePeriod> getAccessTimesList()

Optional. The time periods when the site is accessible. If this field is empty, the site is accessible at all times.

This field is used by Google to schedule the initial installation as well as any later hardware maintenance. You may update this at any time. For example, if the initial installation is requested during off-hours but maintenance should be performed during regular business hours, you should update the access times after initial installation is complete.

repeated .google.cloud.gdchardwaremanagement.v1alpha.TimePeriod access_times = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<TimePeriod>

getAccessTimesOrBuilder(int index)

public abstract TimePeriodOrBuilder getAccessTimesOrBuilder(int index)

Optional. The time periods when the site is accessible. If this field is empty, the site is accessible at all times.

This field is used by Google to schedule the initial installation as well as any later hardware maintenance. You may update this at any time. For example, if the initial installation is requested during off-hours but maintenance should be performed during regular business hours, you should update the access times after initial installation is complete.

repeated .google.cloud.gdchardwaremanagement.v1alpha.TimePeriod access_times = 26 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
TimePeriodOrBuilder

getAccessTimesOrBuilderList()

public abstract List<? extends TimePeriodOrBuilder> getAccessTimesOrBuilderList()

Optional. The time periods when the site is accessible. If this field is empty, the site is accessible at all times.

This field is used by Google to schedule the initial installation as well as any later hardware maintenance. You may update this at any time. For example, if the initial installation is requested during off-hours but maintenance should be performed during regular business hours, you should update the access times after initial installation is complete.

repeated .google.cloud.gdchardwaremanagement.v1alpha.TimePeriod access_times = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.gdchardwaremanagement.v1alpha.TimePeriodOrBuilder>

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Time when this site was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time when this site was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getCustomerSiteId()

public abstract String getCustomerSiteId()

Optional. Customer defined identifier for this Site. This can be used to identify the site in the customer's own systems.

string customer_site_id = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The customerSiteId.

getCustomerSiteIdBytes()

public abstract ByteString getCustomerSiteIdBytes()

Optional. Customer defined identifier for this Site. This can be used to identify the site in the customer's own systems.

string customer_site_id = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for customerSiteId.

getDescription()

public abstract String getDescription()

Optional. Description of this Site.

string description = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. Description of this Site.

string description = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public abstract String getDisplayName()

Optional. Display name of this Site.

string display_name = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Optional. Display name of this Site.

string display_name = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

getGoogleMapsPinUri()

public abstract String getGoogleMapsPinUri()

Optional. A URL to the Google Maps address location of the site. An example value is https://goo.gl/maps/xxxxxxxxx.

string google_maps_pin_uri = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The googleMapsPinUri.

getGoogleMapsPinUriBytes()

public abstract ByteString getGoogleMapsPinUriBytes()

Optional. A URL to the Google Maps address location of the site. An example value is https://goo.gl/maps/xxxxxxxxx.

string google_maps_pin_uri = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for googleMapsPinUri.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Optional. Labels associated with this site as key value pairs. For more information about labels, see Create and manage labels.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Optional. Labels associated with this site as key value pairs. For more information about labels, see Create and manage labels.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Optional. Labels associated with this site as key value pairs. For more information about labels, see Create and manage labels.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Optional. Labels associated with this site as key value pairs. For more information about labels, see Create and manage labels.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public abstract String getName()

Identifier. Name of the site. Format: projects/{project}/locations/{location}/sites/{site}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. Name of the site. Format: projects/{project}/locations/{location}/sites/{site}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getNotes()

public abstract String getNotes()

Optional. Any additional notes for this Site. Please include information about:

  • security or access restrictions
  • any regulations affecting the technicians visiting the site
  • any special process or approval required to move the equipment
  • whether a representative will be available during site visits

string notes = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The notes.

getNotesBytes()

public abstract ByteString getNotesBytes()

Optional. Any additional notes for this Site. Please include information about:

  • security or access restrictions
  • any regulations affecting the technicians visiting the site
  • any special process or approval required to move the equipment
  • whether a representative will be available during site visits

string notes = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for notes.

getOrganizationContact()

public abstract OrganizationContact getOrganizationContact()

Required. Contact information for this site.

.google.cloud.gdchardwaremanagement.v1alpha.OrganizationContact organization_contact = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
OrganizationContact

The organizationContact.

getOrganizationContactOrBuilder()

public abstract OrganizationContactOrBuilder getOrganizationContactOrBuilder()

Required. Contact information for this site.

.google.cloud.gdchardwaremanagement.v1alpha.OrganizationContact organization_contact = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
OrganizationContactOrBuilder

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. Time when this site was last updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Time when this site was last updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Time when this site was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasOrganizationContact()

public abstract boolean hasOrganizationContact()

Required. Contact information for this site.

.google.cloud.gdchardwaremanagement.v1alpha.OrganizationContact organization_contact = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the organizationContact field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. Time when this site was last updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.